メインコンテンツまでスキップ
メインコンテンツまでスキップ

その他の関数

hostName

この関数が実行されたホストの名前を返します。関数がリモートサーバー(分散処理)で実行される場合、リモートサーバー名が返されます。 関数が分散テーブルのコンテキストで実行される場合、各シャードに関連する値を持つ通常のカラムが生成されます。それ以外の場合は定数値が生成されます。

構文

hostName()

返される値

getMacro

サーバー設定の macros セクションから名前付き値を返します。

構文

getMacro(name);

引数

  • name<macros> セクションから取得するマクロ名。 String.

返される値

  • 指定したマクロの値。 String.

サーバー設定ファイル内の例 <macros> セクション:

<macros>
    <test>Value</test>
</macros>

クエリ:

SELECT getMacro('test');

結果:

┌─getMacro('test')─┐
│ Value            │
└──────────────────┘

同じ値は次のように取得できます:

SELECT * FROM system.macros
WHERE macro = 'test';
┌─macro─┬─substitution─┐
│ test  │ Value        │
└───────┴──────────────┘

fqdn

ClickHouseサーバーの完全修飾ドメイン名を返します。

構文

fqdn();

エイリアス: fullHostName, FQDN.

返される値

  • 完全修飾ドメイン名を持つ文字列。 String.

SELECT FQDN();

結果:

┌─FQDN()──────────────────────────┐
│ clickhouse.ru-central1.internal │
└─────────────────────────────────┘

basename

文字列の最後のスラッシュまたはバックスラッシュ以降を抽出します。この関数は、パスからファイル名を抽出するのによく使用されます。

basename(expr)

引数

  • exprString型の値。バックスラッシュはエスケープする必要があります。

返される値

入力文字列の最後のスラッシュまたはバックスラッシュの後にある:

  • 入力文字列がスラッシュまたはバックスラッシュで終わる場合(例: / または c:\)、関数は空の文字列を返します。
  • スラッシュまたはバックスラッシュが存在しない場合は元の文字列を返します。

クエリ:

SELECT 'some/long/path/to/file' AS a, basename(a)

結果:

┌─a──────────────────────┬─basename('some\\long\\path\\to\\file')─┐
│ some\long\path\to\file │ file                                   │
└────────────────────────┴────────────────────────────────────────┘

クエリ:

SELECT 'some\\long\\path\\to\\file' AS a, basename(a)

結果:

┌─a──────────────────────┬─basename('some\\long\\path\\to\\file')─┐
│ some\long\path\to\file │ file                                   │
└────────────────────────┴────────────────────────────────────────┘

クエリ:

SELECT 'some-file-name' AS a, basename(a)

結果:

┌─a──────────────┬─basename('some-file-name')─┐
│ some-file-name │ some-file-name             │
└────────────────┴────────────────────────────┘

visibleWidth

値をテキスト形式(タブ区切り)でコンソールに出力する際の概算幅を計算します。 この関数は、Pretty形式を実装するためにシステムによって使用されます。

NULLは、Pretty形式のNULLに対応する文字列として表されます。

構文

visibleWidth(x)

クエリ:

SELECT visibleWidth(NULL)

結果:

┌─visibleWidth(NULL)─┐
│                  4 │
└────────────────────┘

toTypeName

渡された引数の型名を返します。

NULLが渡された場合、関数は型 Nullable(Nothing) を返し、これはClickHouseの内部でのNULL表現に対応しています。

構文

toTypeName(value)

引数

  • value — 任意の型の値。

返される値

  • 入力値のデータ型名。 String.

クエリ:

SELECT toTypeName(123);

結果:

┌─toTypeName(123)─┐
│ UInt8           │
└─────────────────┘

blockSize

ClickHouseでは、クエリはブロック(チャンク)で処理されます。 この関数は、関数が呼び出されているブロックのサイズ(行数)を返します。

構文

blockSize()

クエリ:

DROP TABLE IF EXISTS test;
CREATE TABLE test (n UInt8) ENGINE = Memory;

INSERT INTO test
SELECT * FROM system.numbers LIMIT 5;

SELECT blockSize()
FROM test;

結果:

   ┌─blockSize()─┐
1. │           5 │
2. │           5 │
3. │           5 │
4. │           5 │
5. │           5 │
   └─────────────┘

byteSize

メモリ内の引数の非圧縮バイトサイズの推定値を返します。

構文

byteSize(argument [, ...])

引数

  • argument — 値。

返される値

  • メモリ内の引数のバイトサイズの推定値。 UInt64.

String 引数の場合、この関数は文字列の長さ + 8(長さ)を返します。

クエリ:

SELECT byteSize('string');

結果:

┌─byteSize('string')─┐
│                 15 │
└────────────────────┘

クエリ:

CREATE TABLE test
(
    `key` Int32,
    `u8` UInt8,
    `u16` UInt16,
    `u32` UInt32,
    `u64` UInt64,
    `i8` Int8,
    `i16` Int16,
    `i32` Int32,
    `i64` Int64,
    `f32` Float32,
    `f64` Float64
)
ENGINE = MergeTree
ORDER BY key;

INSERT INTO test VALUES(1, 8, 16, 32, 64,  -8, -16, -32, -64, 32.32, 64.64);

SELECT key, byteSize(u8) AS `byteSize(UInt8)`, byteSize(u16) AS `byteSize(UInt16)`, byteSize(u32) AS `byteSize(UInt32)`, byteSize(u64) AS `byteSize(UInt64)`, byteSize(i8) AS `byteSize(Int8)`, byteSize(i16) AS `byteSize(Int16)`, byteSize(i32) AS `byteSize(Int32)`, byteSize(i64) AS `byteSize(Int64)`, byteSize(f32) AS `byteSize(Float32)`, byteSize(f64) AS `byteSize(Float64)` FROM test ORDER BY key ASC FORMAT Vertical;

結果:

Row 1:
──────
key:               1
byteSize(UInt8):   1
byteSize(UInt16):  2
byteSize(UInt32):  4
byteSize(UInt64):  8
byteSize(Int8):    1
byteSize(Int16):   2
byteSize(Int32):   4
byteSize(Int64):   8
byteSize(Float32): 4
byteSize(Float64): 8

関数に複数の引数がある場合、関数はそれらのバイトサイズを合計します。

クエリ:

SELECT byteSize(NULL, 1, 0.3, '');

結果:

┌─byteSize(NULL, 1, 0.3, '')─┐
│                         19 │
└────────────────────────────┘

materialize

定数を単一値を含む完全なカラムに変換します。 完全なカラムと定数は、メモリ内で異なる形で表されます。 関数は通常、通常の引数と定数引数のために異なるコードを実行しますが、通常、結果は同じである必要があります。 この関数は、この動作をデバッグするために使用できます。

構文

materialize(x)

引数

返される値

  • 単一値 x を含むカラム。

以下の例では、countMatches 関数は定数の第二引数を期待します。 この動作は、materialize 関数を使用して定数を完全なカラムに変換することでデバッグでき、 関数が非定数引数に対してエラーをスローすることを確認します。

クエリ:

SELECT countMatches('foobarfoo', 'foo');
SELECT countMatches('foobarfoo', materialize('foo'));

結果:

2
Code: 44. DB::Exception: Received from localhost:9000. DB::Exception: Illegal type of argument #2 'pattern' of function countMatches, expected constant String, got String

ignore

任意の引数を受け入れ、無条件に 0 を返します。 引数は内部で評価されるため、たとえばベンチマーキングに便利です。

構文

ignore([arg1[, arg2[, ...]])

引数

  • 任意の型の任意の数の引数を受け入れ、NULLを含むことができます。

返される値

  • 0 を返します。

クエリ:

SELECT ignore(0, 'ClickHouse', NULL);

結果:

┌─ignore(0, 'ClickHouse', NULL)─┐
│                             0 │
└───────────────────────────────┘

sleep

クエリの実行に遅延または一時停止を導入するために使用されます。主にテストやデバッグの目的で使用されます。

構文

sleep(seconds)

引数

  • seconds: UInt* または Float クエリの実行を最大3秒間一時停止する秒数。小数点値を指定することで、部分的な秒数を指定できます。

返される値

この関数は、値を返しません。

この関数は値を返しません。ただし、clickhouse client で関数を実行すると、以下のような出力が表示されます:

SELECT sleep(2)

Query id: 8aa9943e-a686-45e1-8317-6e8e3a5596ac

┌─sleep(2)─┐
│        0 │
└──────────┘

1 row in set. Elapsed: 2.012 sec.

このクエリは、完了するまでに2秒間一時停止します。この間、結果は返されず、クエリはハングしているか、応答がないように見えるでしょう。

実装の詳細

sleep() 関数は、クエリのパフォーマンスやシステムの応答性に悪影響を及ぼす可能性があるため、一般的に本番環境では使用されません。しかし、次のシナリオでは役立ちます。

  1. テスト: ClickHouseをテストまたはベンチマークする際、システムの特定の条件下での動作を観察するために遅延をシミュレートしたり、一時停止を導入したりすることがあります。
  2. デバッグ: システムの状態やクエリの実行を特定の時点で検査する必要がある場合は、sleep() を使用して一時停止を導入し、関連情報を検査または収集できます。
  3. シミュレーション: 一部のケースでは、遅延や一時停止が発生する現実のシナリオをシミュレートしたい場合があります。たとえば、ネットワークの遅延や外部システムの依存関係などです。

sleep() 関数は、慎重に必要な場合のみ使用することが重要です。特に大きな結果セットを扱う際には、ClickHouseシステム全体のパフォーマンスや応答性に影響を与える可能性があります。

sleepEachRow

結果セット内の各行に対して指定された秒数、クエリの実行を一時停止します。

構文

sleepEachRow(seconds)

引数

  • seconds: UInt* または Float* 結果セット内の各行に対してクエリの実行を1行あたり最大3秒間一時停止するための秒数。小数点値を指定することで、部分的な秒数を指定できます。

返される値

この関数は受け取った入力値と同じ値を返し、変更しません。

SELECT number, sleepEachRow(0.5) FROM system.numbers LIMIT 5;
┌─number─┬─sleepEachRow(0.5)─┐
│      0 │                 0 │
│      1 │                 0 │
│      2 │                 0 │
│      3 │                 0 │
│      4 │                 0 │
└────────┴───────────────────┘

ただし、出力は遅延され、各行の間に0.5秒の一時停止があります。

sleepEachRow()関数は、sleep()関数と同様に、主にテストやデバッグの目的で使用されます。各行の処理に遅延をシミュレートまたは導入することで、次のようなシナリオに役立ちます。

  1. テスト: 特定の条件下でのClickHouseのパフォーマンスをテストまたはベンチマークする際に、sleepEachRow()を使用して処理される各行の遅延や一時停止をシミュレートできます。
  2. デバッグ: 各行が処理される際にシステムの状態またはクエリの実行を調査する必要がある場合は、sleepEachRow()を使用して一時停止を導入し、関連情報を検査または収集できます。
  3. シミュレーション: 一部のケースでは、外部システムやネットワークの遅延を扱う際に、各行処理の遅延や一時停止をシミュレートしたい場合があります。

sleep() 関数と同様に、sleepEachRow()は慎重に必要な場合のみ使用することが重要です。特に大きな結果セットを扱う際には、ClickHouseシステム全体のパフォーマンスや応答性に大きな影響を与える可能性があります。

currentDatabase

現在のデータベースの名前を返します。 CREATE TABLEクエリのテーブルエンジンパラメータにおいて、データベースを指定する必要がある場合に役立ちます。

構文

currentDatabase()

返される値

  • 現在のデータベース名を返します。 String.

クエリ:

SELECT currentDatabase()

結果:

┌─currentDatabase()─┐
│ default           │
└───────────────────┘

currentUser

現在のユーザーの名前を返します。分散クエリの場合は、クエリを開始したユーザーの名前が返されます。

構文

currentUser()

エイリアス: user(), USER(), current_user()。エイリアスは大文字と小文字を区別しません。

返される値

  • 現在のユーザーの名前。 String.
  • 分散クエリの場合、クエリを開始したユーザーのログイン名。 String.

SELECT currentUser();

結果:

┌─currentUser()─┐
│ default       │
└───────────────┘

currentSchemas

現在のデータベーススキーマの名前を含む単一要素配列を返します。

構文

currentSchemas(bool)

エイリアス: current_schemas

引数

  • bool: ブール値。 Bool.
注記

ブール引数は無視されます。これは、PostgreSQLでのこの関数の実装との互換性のために存在するだけです。

返される値

  • 現在のデータベースの名前を含む単一要素配列を返します。

SELECT currentSchemas(true);

結果:

['default']

colorSRGBToOKLCH

sRGB カラー空間でエンコードされた色を知覚的一様な OKLCH カラー空間に変換します。

もし入力チャンネルのいずれかが [0...255] の範囲外であるか、ガンマ値が非正である場合、動作は実装依存です。

注記

OKLCH は OKLab カラー空間の円柱バージョンです。
その3つの座標は L (範囲 [0...1] の明るさ)、 C (クロマ >= 0) および H (度数としての色相 [0...360]) です。
OKLab/OKLCH は計算が安価でありながら、知覚的に一様であるように設計されています。

構文

colorSRGBToOKLCH(tuple [, gamma])

引数

  • tuple - 値の範囲 [0...255] の三つの数値 R, G, B。 Tuple.
  • gamma - 任意の数値。各チャンネル x(x / 255)^gamma を適用して sRGB を線形化するために使用される指数。デフォルトは 2.2 です。

返される値

  • (L, C, H) の tuple (type Tuple(Float64, Float64, Float64))。

実装の詳細

変換は3つのステージで構成します:

  1. sRGB から Linear sRGB へ
  2. Linear sRGB から OKLab へ
  3. OKLab から OKLCH へ 。

ガンマは最初のステージ、つまり線形sRGBを計算する際に使用されます。
そのため、sRGB値を正規化し、それらをガンマの冪で計算します。
これにより、浮動小数点の丸め誤差により精度が失われることがあります。
この設計選択は、異なるガンマの値を迅速に計算できるようにするために行われました、そしてその違いは色の知覚に大きな影響を与えないからです。

次の二つの段階は、それぞれ行列の乗算と三角関数の変換を含みます。
数学に関する詳細は、OKLabカラースペースに関する記事を参照してください: https://bottosson.github.io/posts/OKLab/

OKLCH空間の色とそれがsRGB色にどのように対応するかの参照を持つために、https://OKLCH.com/ をご覧ください。

SELECT colorSRGBToOKLCH((128, 64, 32), 2.2) AS lch;

結果:

┌─lch─────────────────────────────────────────────────────────┐
│ (0.4436238384931984,0.10442699545678624,45.907345481930236) │
└─────────────────────────────────────────────────────────────┘

colorOKLCHToSRGB

OKLCH 知覚色空間から一般的な sRGB 色空間に色を変換します。

L[0...1] の範囲外であるか、 C が負であるか、 H[0...360] の範囲外の場合、結果は実装依存です。

注記

OKLCH は OKLab カラー空間の円柱バージョンです。
その3つの座標は L (範囲 [0...1] の明るさ)、 C (クロマ >= 0) および H (度数としての色相 [0...360]) です。
OKLab/OKLCH は計算が安価でありながら、知覚的に一様であるように設計されています。

構文

colorOKLCHToSRGB(tuple [, gamma])

引数

  • tuple - 三つの数値 L, C, H で構成されるタプル、 L は範囲 [0...1]C>= 0 であり H は範囲 [0...360] です。 Tuple.
  • gamma - 任意の数値。線形 sRGB を sRGB に戻すために (x ^ (1 / gamma)) * 255 を各チャンネル x に適用するために使用される指数。デフォルトは 2.2 です。

返される値

  • (R, G, B) の tuple (type Tuple(Float64, Float64, Float64))。
注記

この関数は浮動小数点数を返します。整数値ではなく、丸めを強制しないようにするためです。ユーザーは自分で丸めを行なうことができます。

実装の詳細

変換は colorSRGBToOKLCH の逆です:

  1. OKLCH から OKLab へ。
  2. OKLab から Linear sRGB へ。
  3. Linear sRGB から sRGB へ。

第2引数のガンマは最終段階で使用されます。
すべての3つのチャンネルは、線形 sRGB を計算する直前に [0...1] の範囲でクリップされ、その後 1 / gamma の冪に設定されます。
ガンマが 0 の場合、 1 / gamma1'000'000 に変更されます。
そのため、入力に関係なく、通常は [0...255] の範囲の浮動小数点が返されます。

colorSRGBToOKLCH の場合と同様に、他の二つの段階ではそれぞれ三角関数の変換と行列の乗算が含まれます。
数学に関する詳細は、OKLab カラースペースに関する記事を参照してください: https://bottosson.github.io/posts/oklab/

OKLCH 空間の色とそれが sRGB 色にどのように対応するかの参照を持つために、https://oklch.com/ をご覧ください。

SELECT colorOKLCHToSRGB((0.4466, 0.0991, 45.44), 2.2) AS rgb
WITH colorOKLCHToSRGB((0.7, 0.1, 54)) as t SELECT tuple(toUInt8(t.1), toUInt8(t.2), toUInt8(t.3)) AS RGB

結果:

┌─rgb──────────────────────────────────────────────────────┐
│ (127.03349738778945,66.06672044472008,37.11802592155851) │
└──────────────────────────────────────────────────────────┘

┌─RGB──────────┐
│ (205,139,97) │
└──────────────┘

isConstant

引数が定数式であるかどうかを返します。

定数式は、クエリ解析中に結果が知られている式、すなわち実行前に知られている式です。たとえば、リテラル に対する式は定数式です。

この関数は主に開発、デバッグ、およびデモンストレーションを目的としています。

構文

isConstant(x)

引数

  • x — 確認する式。

返される値

  • 1 如果 x 是定数 します。 UInt8.
  • 0 如果 x 是非定数 します。 UInt8.

クエリ:

SELECT isConstant(x + 1) FROM (SELECT 43 AS x)

結果:

┌─isConstant(plus(x, 1))─┐
│                      1 │
└────────────────────────┘

クエリ:

WITH 3.14 AS pi SELECT isConstant(cos(pi))

結果:

┌─isConstant(cos(pi))─┐
│                   1 │
└─────────────────────┘

クエリ:

SELECT isConstant(number) FROM numbers(1)

結果:

┌─isConstant(number)─┐
│                  0 │
└────────────────────┘

hasColumnInTable

データベース名、テーブル名、およびカラム名を定数文字列として与えられた場合、指定されたカラムが存在すれば1を返し、そうでなければ0を返します。

構文

hasColumnInTable(\['hostname'\[, 'username'\[, 'password'\]\],\] 'database', 'table', 'column')

引数

返される値

  • 指定されたカラムが存在する場合は 1
  • それ以外の場合は 0

実装の詳細

ネストされたデータ構造内の要素に対して、関数はカラムの存在を確認します。ネストされたデータ構造自体に対しては、関数は0を返します。

クエリ:

SELECT hasColumnInTable('system','metrics','metric')
1
SELECT hasColumnInTable('system','metrics','non-existing_column')
0

hasThreadFuzzer

スレッドファズァが有效かどうかを返します。これは、テストで実行時間が長すぎることを防ぐために使用できます。

構文

hasThreadFuzzer();

bar

棒グラフを構築します。

bar(x, min, max, width)(x - min) に比例した幅を描き、 x = max のときに width 文字に等しいバンドを描きます。

引数

  • x — 表示するサイズ。
  • min, max — 整数定数。値は Int64 に収まる必要があります。
  • width — 定数の正の整数で、小数点数になる可能性があります。

バンドは、1つの記号の8分の1の精度で描かれます。

例:

SELECT
    toHour(EventTime) AS h,
    count() AS c,
    bar(c, 0, 600000, 20) AS bar
FROM test.hits
GROUP BY h
ORDER BY h ASC
┌──h─┬──────c─┬─bar────────────────┐
│  0 │ 292907 │ █████████▋         │
│  1 │ 180563 │ ██████             │
│  2 │ 114861 │ ███▋               │
│  3 │  85069 │ ██▋                │
│  4 │  68543 │ ██▎                │
│  5 │  78116 │ ██▌                │
│  6 │ 113474 │ ███▋               │
│  7 │ 170678 │ █████▋             │
│  8 │ 278380 │ █████████▎         │
│  9 │ 391053 │ █████████████      │
│ 10 │ 457681 │ ███████████████▎   │
│ 11 │ 493667 │ ████████████████▍  │
│ 12 │ 509641 │ ████████████████▊  │
│ 13 │ 522947 │ █████████████████▍ │
│ 14 │ 539954 │ █████████████████▊ │
│ 15 │ 528460 │ █████████████████▌ │
│ 16 │ 539201 │ █████████████████▊ │
│ 17 │ 523539 │ █████████████████▍ │
│ 18 │ 506467 │ ████████████████▊  │
│ 19 │ 520915 │ █████████████████▎ │
│ 20 │ 521665 │ █████████████████▍ │
│ 21 │ 542078 │ ██████████████████ │
│ 22 │ 493642 │ ████████████████▍  │
│ 23 │ 400397 │ █████████████▎     │
└────┴────────┴────────────────────┘

transform

明示的に定義されたいくつかの要素のマッピングに従って値を変換します。 この関数には2つのバリエーションがあります。

transform(x, array_from, array_to, default)

x – 変換するもの。

array_from – 変換する値の定数配列。

array_tofrom の値を変換するための値の定数配列。

defaultxfrom のいずれの値とも等しくない場合に使用する値。

array_fromarray_to は同じ数の要素を持っている必要があります。

シグネチャ:

array_from の要素のいずれかと等しい x の場合、関数は array_to の対応する要素を、すなわち同じ配列インデックスのものを返します。
そうでない場合は default を返します。 array_from に複数の一致する要素が存在する場合、最初の一致する要素に対応する要素が返されます。

transform(T, Array(T), Array(U), U) -> U

T および U は数値、文字列、または Date または DateTime 型であることができます。 同じ文字(T または U)は、型が相互に互換性があり、必ずしも等しくはないことを意味します。
たとえば、最初の引数は型 Int64 である一方、2番目の引数は型 Array(UInt16) である可能性があります。

例:

SELECT
    transform(SearchEngineID, [2, 3], ['Yandex', 'Google'], 'Other') AS title,
    count() AS c
FROM test.hits
WHERE SearchEngineID != 0
GROUP BY title
ORDER BY c DESC
┌─title─────┬──────c─┐
│ Yandex    │ 498635 │
│ Google    │ 229872 │
│ Other     │ 104472 │
└───────────┴────────┘

transform(x, array_from, array_to)

他のバリエーションと同様ですが、'default' 引数がありません。一致するものが見つからない場合は x を返します。

例:

SELECT
    transform(domain(Referer), ['yandex.ru', 'google.ru', 'vkontakte.ru'], ['www.yandex', 'example.com', 'vk.com']) AS s,
    count() AS c
FROM test.hits
GROUP BY domain(Referer)
ORDER BY count() DESC
LIMIT 10
┌─s──────────────┬───────c─┐
│                │ 2906259 │
│ www.yandex     │  867767 │
│ ███████.ru     │  313599 │
│ mail.yandex.ru │  107147 │
│ ██████.ru      │  100355 │
│ █████████.ru   │   65040 │
│ news.yandex.ru │   64515 │
│ ██████.net     │   59141 │
│ example.com    │   57316 │
└────────────────┴─────────┘

formatReadableDecimalSize

サイズ(バイト数)を受け取ると、この関数は suffix (KB, MB など) を含む可読性のある四捨五入されたサイズを文字列として返します。

この関数の逆操作は、parseReadableSizeparseReadableSizeOrZero、および parseReadableSizeOrNull です。

構文

formatReadableDecimalSize(x)

クエリ:

SELECT
    arrayJoin([1, 1024, 1024*1024, 192851925]) AS filesize_bytes,
    formatReadableDecimalSize(filesize_bytes) AS filesize

結果:

┌─filesize_bytes─┬─filesize───┐
│              1 │ 1.00 B     │
│           1024 │ 1.02 KB   │
│        1048576 │ 1.05 MB   │
│      192851925 │ 192.85 MB │
└────────────────┴────────────┘

formatReadableSize

サイズ(バイト数)を受け取ると、この関数は suffix (KiB, MiB など) を含む可読性のある四捨五入されたサイズを文字列として返します。

この関数の逆操作は、parseReadableSizeparseReadableSizeOrZero、および parseReadableSizeOrNull です。

構文

formatReadableSize(x)

エイリアス: FORMAT_BYTES.

注記

この関数はあらゆる数値型の入力を受け入れますが、内部的には Float64 にキャストします。大きな値の場合の結果は最適でない可能性があります。

クエリ:

SELECT
    arrayJoin([1, 1024, 1024*1024, 192851925]) AS filesize_bytes,
    formatReadableSize(filesize_bytes) AS filesize

結果:

┌─filesize_bytes─┬─filesize───┐
│              1 │ 1.00 B     │
│           1024 │ 1.00 KiB   │
│        1048576 │ 1.00 MiB   │
│      192851925 │ 183.92 MiB │
└────────────────┴────────────┘

formatReadableQuantity

数値を受け取ると、この関数は、サフィックス(千、百万、十億など)を含む、丸められた数値を文字列として返します。

構文

formatReadableQuantity(x)
注記

この関数はあらゆる数値型の入力を受け入れますが、内部的には Float64 にキャストします。大きな値の場合の結果は最適でない可能性があります。

クエリ:

SELECT
    arrayJoin([1024, 1234 * 1000, (4567 * 1000) * 1000, 98765432101234]) AS number,
    formatReadableQuantity(number) AS number_for_humans

結果:

┌─────────number─┬─number_for_humans─┐
│           1024 │ 1.02 thousand     │
│        1234000 │ 1.23 million      │
│     4567000000 │ 4.57 billion      │
│ 98765432101234 │ 98.77 trillion    │
└────────────────┴───────────────────┘

formatReadableTimeDelta

秒単位の時間間隔(デルタ)を受け取ると、この関数は年/月/日/時間/分/秒/ミリ秒/マイクロ秒/ナノ秒を含む時間デルタを文字列として返します。

構文

formatReadableTimeDelta(column[, maximum_unit, minimum_unit])
注記

この関数はあらゆる数値型の入力を受け入れますが、内部的には Float64 にキャストします。大きな値の場合の結果は最適でない可能性があります。

引数

  • column — 数値時間デルタを持つカラム。
  • maximum_unit — 任意。表示する最大単位。
    • 許容値: nanoseconds, microseconds, milliseconds, seconds, minutes, hours, days, months, years
    • デフォルト値: years
  • minimum_unit — 任意。表示する最小単位。すべての小さい単位は切り捨てられます。
    • 許容値: nanoseconds, microseconds, milliseconds, seconds, minutes, hours, days, months, years
    • 明示的に指定された値が maximum_unit よりも大きい場合、例外がスローされます。
    • デフォルト値: secondsmaximum_unitseconds またはそれ以上の場合)、それ以外は nanoseconds

SELECT
    arrayJoin([100, 12345, 432546534]) AS elapsed,
    formatReadableTimeDelta(elapsed) AS time_delta
┌────elapsed─┬─time_delta ─────────────────────────────────────────────────────┐
│        100 │ 1 minute and 40 seconds                                         │
│      12345 │ 3 hours, 25 minutes and 45 seconds                              │
│  432546534 │ 13 years, 8 months, 17 days, 7 hours, 48 minutes and 54 seconds │
└────────────┴─────────────────────────────────────────────────────────────────┘
SELECT
    arrayJoin([100, 12345, 432546534]) AS elapsed,
    formatReadableTimeDelta(elapsed, 'minutes') AS time_delta
┌────elapsed─┬─time_delta ─────────────────────────────────────────────────────┐
│        100 │ 1 minute and 40 seconds                                         │
│      12345 │ 205 minutes and 45 seconds                                      │
│  432546534 │ 7209108 minutes and 54 seconds                                  │
└────────────┴─────────────────────────────────────────────────────────────────┘
SELECT
    arrayJoin([100, 12345, 432546534.00000006]) AS elapsed,
    formatReadableTimeDelta(elapsed, 'minutes', 'nanoseconds') AS time_delta
┌────────────elapsed─┬─time_delta─────────────────────────────────────┐
│                100 │ 1 minute and 40 seconds                        │
│              12345 │ 205 minutes and 45 seconds                     │
│ 432546534.00000006 │ 7209108 minutes, 54 seconds and 60 nanoseconds │
└────────────────────┴────────────────────────────────────────────────┘

parseReadableSize

バイトサイズと B, KiB, KB, MiB, MB などの単位を含む文字列を受け取ると、この関数は対応するバイト数を返します。
もし関数が入力値を解析できない場合、例外がスローされます。

この関数の逆操作は、formatReadableSize および formatReadableDecimalSize です。

構文

parseReadableSize(x)

引数

  • x : ISO/IEC 80000-13 または十進バイト単位を持つ可読サイズ (String)。

返される値

  • バイト数、最も近い整数に四捨五入されます (UInt64)。

SELECT
    arrayJoin(['1 B', '1 KiB', '3 MB', '5.314 KiB']) AS readable_sizes,  
    parseReadableSize(readable_sizes) AS sizes;
┌─readable_sizes─┬───sizes─┐
│ 1 B            │       1 │
│ 1 KiB          │    1024 │
│ 3 MB           │ 3000000 │
│ 5.314 KiB      │    5442 │
└────────────────┴─────────┘

parseReadableSizeOrNull

バイトサイズと B, KiB, KB, MiB, MB などの単位を含む文字列を受け取ると、この関数は対応するバイト数を返します。
もし関数が入力値を解析できない場合、NULL を返します。

この関数の逆操作は、formatReadableSize および formatReadableDecimalSize です。

構文

parseReadableSizeOrNull(x)

引数

  • x : ISO/IEC 80000-13 または十進バイト単位を持つ可読サイズ (String)。

返される値

  • バイト数、最も近い整数に四捨五入されるか、入力を解析できない場合は NULL (Nullable(UInt64))。

SELECT
    arrayJoin(['1 B', '1 KiB', '3 MB', '5.314 KiB', 'invalid']) AS readable_sizes,  
    parseReadableSizeOrNull(readable_sizes) AS sizes;
┌─readable_sizes─┬───sizes─┐
│ 1 B            │       1 │
│ 1 KiB          │    1024 │
│ 3 MB           │ 3000000 │
│ 5.314 KiB      │    5442 │
│ invalid        │    ᴺᵁᴸᴸ │
└────────────────┴─────────┘

parseReadableSizeOrZero

バイトサイズと B, KiB, KB, MiB, MB などの単位を含む文字列を受け取ると、この関数は対応するバイト数を返します。関数が入力値を解析できない場合、0 を返します。

この関数の逆操作は、formatReadableSize および formatReadableDecimalSize です。

構文

parseReadableSizeOrZero(x)

引数

  • x : ISO/IEC 80000-13 または十進バイト単位を持つ可読サイズ (String)。

返される値

  • バイト数、最も近い整数に四捨五入されるか、入力を解析できない場合は 0 (UInt64)。

SELECT
    arrayJoin(['1 B', '1 KiB', '3 MB', '5.314 KiB', 'invalid']) AS readable_sizes,  
    parseReadableSizeOrZero(readable_sizes) AS sizes;
┌─readable_sizes─┬───sizes─┐
│ 1 B            │       1 │
│ 1 KiB          │    1024 │
│ 3 MB           │ 3000000 │
│ 5.314 KiB      │    5442 │
│ invalid        │       0 │
└────────────────┴─────────┘

parseTimeDelta

時間単位に類似した何かの後に続く数字のシーケンスを解析します。

構文

parseTimeDelta(timestr)

引数

  • timestr — 時間単位に類似した何かの後に続く数字のシーケンス。

返される値

  • 秒数を持つ浮動小数点数。

SELECT parseTimeDelta('11s+22min')
┌─parseTimeDelta('11s+22min')─┐
│                        1331 │
└─────────────────────────────┘
SELECT parseTimeDelta('1yr2mo')
┌─parseTimeDelta('1yr2mo')─┐
│                 36806400 │
└──────────────────────────┘

least

1つ以上の入力引数の中で最も小さい引数を返します。 NULL 引数は無視されます。

構文

least(a, b)
注記

バージョン 24.12 では、NULL値が無視されるという後方互換性のない変更が導入されましたが、以前は引数のいずれかが NULL であれば NULL を返していました。以前の動作を保持するには、設定 least_greatest_legacy_null_behavior(デフォルト: false)を true に設定してください。

greatest

1つ以上の入力引数の中で最も大きい引数を返します。 NULL 引数は無視されます。

構文

greatest(a, b)
注記

バージョン 24.12 では、NULL値が無視されるという後方互換性のない変更が導入されましたが、以前は引数のいずれかが NULL であれば NULL を返していました。以前の動作を保持するには、設定 least_greatest_legacy_null_behavior(デフォルト: false)を true に設定してください。

uptime

サーバーの稼働時間を秒単位で返します。 分散テーブルのコンテキストで実行される場合、この関数は各シャードに関連する値を持つ通常のカラムを生成します。それ以外の場合は定数値を生成します。

構文

uptime()

返される値

  • 時間の値(秒)。 UInt32.

クエリ:

SELECT uptime() AS Uptime;

結果:

┌─Uptime─┐
│  55867 │
└────────┘

version

ClickHouseの現在のバージョンを文字列形式で返します:

  • メジャーバージョン
  • マイナーバージョン
  • パッチバージョン
  • 前回の安定版リリースからのコミット数
major_version.minor_version.patch_version.number_of_commits_since_the_previous_stable_release

分散テーブルのコンテキストで実行される場合、この関数は各シャードに関連する値を持つ通常のカラムを生成します。それ以外の場合は定数値を生成します。

構文

version()

引数

なし。

返される値

  • ClickHouseの現在のバージョン。 String.

実装の詳細

なし。

クエリ:

SELECT version()

結果:

┌─version()─┐
│ 24.2.1.1  │
└───────────┘

buildId

実行中のClickHouseサーバーバイナリ用にコンパイラによって生成されたビルドIDを返します。 分散テーブルのコンテキストで実行される場合、この関数は各シャードに関連する値を持つ通常のカラムを生成します。それ以外の場合は定数値を生成します。

構文

buildId()

blockNumber

行を含むデータのブロックの monotonically increasing なシーケンス番号を返します。 返されたブロック番号は最善の努力のもとで更新されます。つまり、必ずしも完全に正確であるとは限りません。

構文

blockNumber()

返される値

  • 行が位置するデータブロックのシーケンス番号。 UInt64.

クエリ:

SELECT blockNumber()
FROM
(
    SELECT *
    FROM system.numbers
    LIMIT 10
) SETTINGS max_block_size = 2

結果:

┌─blockNumber()─┐
│             7 │
│             7 │
└───────────────┘
┌─blockNumber()─┐
│             8 │
│             8 │
└───────────────┘
┌─blockNumber()─┐
│             9 │
│             9 │
└───────────────┘
┌─blockNumber()─┐
│            10 │
│            10 │
└───────────────┘
┌─blockNumber()─┐
│            11 │
│            11 │
└───────────────┘

rowNumberInBlock

rowNumberInBlock によって処理される各ブロックに対して、現在の行の番号を返します。 返される番号は各ブロックごとに0から始まります。

構文

rowNumberInBlock()

返される値

  • データブロック内の行の順序番号(0から始まる)。 UInt64.

クエリ:

SELECT rowNumberInBlock()
FROM
(
    SELECT *
    FROM system.numbers_mt
    LIMIT 10
) SETTINGS max_block_size = 2

結果:

┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘

rowNumberInAllBlocks

rowNumberInAllBlocks によって処理される各行に対して、一意の行番号を返します。返される番号は0から始まります。

構文

rowNumberInAllBlocks()

返される値

  • データブロック内の行の順序番号(0から始まる)。 UInt64.

クエリ:

SELECT rowNumberInAllBlocks()
FROM
(
    SELECT *
    FROM system.numbers_mt
    LIMIT 10
)
SETTINGS max_block_size = 2

結果:

┌─rowNumberInAllBlocks()─┐
│                      0 │
│                      1 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      4 │
│                      5 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      2 │
│                      3 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      6 │
│                      7 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      8 │
│                      9 │
└────────────────────────┘

normalizeQuery

リテラル、リテラルのシーケンス、および複雑なエイリアス(ホワイトスペース、2桁以上、または最少36バイトの長さのUUIDを含む) をプレースホルダー?に置き換えます。

構文

normalizeQuery(x)

引数

  • x — 文字のシーケンス。 String.

返される値

  • プレースホルダーを含む文字のシーケンス。 String.

クエリ:

SELECT normalizeQuery('[1, 2, 3, x]') AS query;

結果:

┌─query────┐
│ [?.., x] │
└──────────┘

normalizeQueryKeepNames

リテラル、リテラルのシーケンスをプレースホルダー? に置き換えますが、複雑なエイリアス(ホワイトスペース、2桁以上、または最少36バイトの長さのUUIDを含む)は置き換えません。これにより、複雑なクエリログをより良く分析できます。

構文

normalizeQueryKeepNames(x)

引数

  • x — 文字のシーケンス。 String.

返される値

  • プレースホルダーを含む文字のシーケンス。 String.

クエリ:

SELECT normalizeQuery('SELECT 1 AS aComplexName123'), normalizeQueryKeepNames('SELECT 1 AS aComplexName123');

結果:

┌─normalizeQuery('SELECT 1 AS aComplexName123')─┬─normalizeQueryKeepNames('SELECT 1 AS aComplexName123')─┐
│ SELECT ? AS `?`                               │ SELECT ? AS aComplexName123                            │
└───────────────────────────────────────────────┴────────────────────────────────────────────────────────┘

normalizedQueryHash

類似のクエリに対してリテラルの値なしで同一の64ビットハッシュ値を返します。クエリログを分析するのに役立ちます。

構文

normalizedQueryHash(x)

引数

  • x — 文字のシーケンス。 String.

返される値

クエリ:

SELECT normalizedQueryHash('SELECT 1 AS `xyz`') != normalizedQueryHash('SELECT 1 AS `abc`') AS res;

結果:

┌─res─┐
│   1 │
└─────┘

normalizedQueryHashKeepNames

normalizedQueryHash と同様に、リテラルの値なしで類似の クエリに対して同一の64ビットハッシュ値を返しますが、ハッシュ化の前に複雑なエイリアス (ホワイトスペース、2桁以上または最少36バイト長のUUIDを含む) はプレースホルダーで置き換えません。クエリログを分析するのに役立ちます。

構文

normalizedQueryHashKeepNames(x)

引数

  • x — 文字のシーケンス。 String.

返される値

SELECT normalizedQueryHash('SELECT 1 AS `xyz123`') != normalizedQueryHash('SELECT 1 AS `abc123`') AS normalizedQueryHash;
SELECT normalizedQueryHashKeepNames('SELECT 1 AS `xyz123`') != normalizedQueryHashKeepNames('SELECT 1 AS `abc123`') AS normalizedQueryHashKeepNames;

結果:

┌─normalizedQueryHash─┐
│                   0 │
└─────────────────────┘
┌─normalizedQueryHashKeepNames─┐
│                            1 │
└──────────────────────────────┘

neighbor

Deprecated feature

指定されたオフセットの前または後の行へのアクセスを提供するウィンドウ関数です。

構文

neighbor(column, offset[, default_value])

関数の結果は、影響を受けるデータブロックとブロック内のデータの順序に依存します。

注記

現在処理されているデータブロック内の隣接行のみを返します。 このエラープローンな動作のため、この関数は非推奨となっていますので、適切なウィンドウ関数を使用してください。

neighbor() の計算中の行の順序は、ユーザーに返される行の順序とは異なる場合があります。 これを防ぐために、ORDER BY でサブクエリを作成し、サブクエリの外部から関数を呼び出すことができます。

引数

  • column — カラム名またはスカラー式。
  • offsetcolumn内の現在の行の前または後に見る行の数。Int64
  • default_value — オプション。オフセットがブロックの境界を超えた場合に返される値。影響を受けるデータブロックの型。

返される値

  • 現在の行からoffset距離のcolumnの値。ただし、offsetがブロックの境界を超えていない場合。
  • columnのデフォルト値またはdefault_value(指定された場合)。オフセットがブロックの境界を超えた場合。
注記

返される型は、影響を受けるデータブロックの型またはデフォルト値の型になります。

クエリ:

SELECT number, neighbor(number, 2) FROM system.numbers LIMIT 10;

結果:

┌─number─┬─neighbor(number, 2)─┐
│      0 │                   2 │
│      1 │                   3 │
│      2 │                   4 │
│      3 │                   5 │
│      4 │                   6 │
│      5 │                   7 │
│      6 │                   8 │
│      7 │                   9 │
│      8 │                   0 │
│      9 │                   0 │
└────────┴─────────────────────┘

クエリ:

SELECT number, neighbor(number, 2, 999) FROM system.numbers LIMIT 10;

結果:

┌─number─┬─neighbor(number, 2, 999)─┐
│      0 │                        2 │
│      1 │                        3 │
│      2 │                        4 │
│      3 │                        5 │
│      4 │                        6 │
│      5 │                        7 │
│      6 │                        8 │
│      7 │                        9 │
│      8 │                      999 │
│      9 │                      999 │
└────────┴──────────────────────────┘

この関数は、前年同期の指標値を計算するために使用できます:

クエリ:

WITH toDate('2018-01-01') AS start_date
SELECT
    toStartOfMonth(start_date + (number * 32)) AS month,
    toInt32(month) % 100 AS money,
    neighbor(money, -12) AS prev_year,
    round(prev_year / money, 2) AS year_over_year
FROM numbers(16)

結果:

┌──────month─┬─money─┬─prev_year─┬─year_over_year─┐
│ 2018-01-01 │    32 │         0 │              0 │
│ 2018-02-01 │    63 │         0 │              0 │
│ 2018-03-01 │    91 │         0 │              0 │
│ 2018-04-01 │    22 │         0 │              0 │
│ 2018-05-01 │    52 │         0 │              0 │
│ 2018-06-01 │    83 │         0 │              0 │
│ 2018-07-01 │    13 │         0 │              0 │
│ 2018-08-01 │    44 │         0 │              0 │
│ 2018-09-01 │    75 │         0 │              0 │
│ 2018-10-01 │     5 │         0 │              0 │
│ 2018-11-01 │    36 │         0 │              0 │
│ 2018-12-01 │    66 │         0 │              0 │
│ 2019-01-01 │    97 │        32 │           0.33 │
│ 2019-02-01 │    28 │        63 │           2.25 │
│ 2019-03-01 │    56 │        91 │           1.62 │
│ 2019-04-01 │    87 │        22 │           0.25 │
└────────────┴───────┴───────────┴────────────────┘

runningDifference

データブロック内の2つの連続した行の値の差を計算します。 最初の行には0を返し、その後の行には前の行との違いを返します。

注記

現在処理されているデータブロック内の違いのみを返します。 このエラープローンな動作のため、この関数は非推奨となっていますので、適切なウィンドウ関数を使用してください。

関数の結果は、影響を受けるデータブロックとブロック内のデータの順序に依存します。

runningDifference()の計算中の行の順序は、ユーザーに返される行の順序とは異なる場合があります。 これを防ぐために、ORDER BYでサブクエリを作成し、サブクエリの外部から関数を呼び出すことができます。

構文

runningDifference(x)

クエリ:

SELECT
    EventID,
    EventTime,
    runningDifference(EventTime) AS delta
FROM
(
    SELECT
        EventID,
        EventTime
    FROM events
    WHERE EventDate = '2016-11-24'
    ORDER BY EventTime ASC
    LIMIT 5
)

結果:

┌─EventID─┬───────────EventTime─┬─delta─┐
│    1106 │ 2016-11-24 00:00:04 │     0 │
│    1107 │ 2016-11-24 00:00:05 │     1 │
│    1108 │ 2016-11-24 00:00:05 │     0 │
│    1109 │ 2016-11-24 00:00:09 │     4 │
│    1110 │ 2016-11-24 00:00:10 │     1 │
└─────────┴─────────────────────┴───────┘

ブロックサイズが結果に影響することに注意してください。runningDifferenceの内部状態は各新しいブロックに対してリセットされます。

クエリ:

SELECT
    number,
    runningDifference(number + 1) AS diff
FROM numbers(100000)
WHERE diff != 1

結果:

┌─number─┬─diff─┐
│      0 │    0 │
└────────┴──────┘
┌─number─┬─diff─┐
│  65536 │    0 │
└────────┴──────┘

クエリ:

set max_block_size=100000 -- default value is 65536!

SELECT
    number,
    runningDifference(number + 1) AS diff
FROM numbers(100000)
WHERE diff != 1

結果:

┌─number─┬─diff─┐
│      0 │    0 │
└────────┴──────┘

runningDifferenceStartingWithFirstValue

注記

この関数は非推奨です(runningDifferenceの注意事項を参照してください)。

runningDifferenceと同じですが、最初の行の値を最初の行の値として返します。

runningConcurrency

同時に発生するイベントの数を計算します。 各イベントには開始時刻と終了時刻があります。開始時刻はイベントに含まれ、終了時刻は除外されます。開始時刻と終了時刻を持つカラムは、同じデータ型でなければなりません。 関数は、各イベント開始時刻のアクティブ(同時)イベントの合計数を計算します。

ヒント

イベントは開始時刻の昇順で並べる必要があります。この要件が破られると、関数は例外を発生させます。各データブロックは別々に処理されます。異なるデータブロックのイベントが重なる場合、正しく処理されません。

構文

runningConcurrency(start, end)

引数

返される値

  • 各イベント開始時刻の同時イベント数。UInt32

次のテーブルを考えてみましょう:

┌──────start─┬────────end─┐
│ 2021-03-03 │ 2021-03-11 │
│ 2021-03-06 │ 2021-03-12 │
│ 2021-03-07 │ 2021-03-08 │
│ 2021-03-11 │ 2021-03-12 │
└────────────┴────────────┘

クエリ:

SELECT start, runningConcurrency(start, end) FROM example_table;

結果:

┌──────start─┬─runningConcurrency(start, end)─┐
│ 2021-03-03 │                              1 │
│ 2021-03-06 │                              2 │
│ 2021-03-07 │                              3 │
│ 2021-03-11 │                              2 │
└────────────┴────────────────────────────────┘

MACNumToString

UInt64の数をMACアドレスのビッグエンディアン形式として解釈します。対応するMACアドレスをAA:BB:CC:DD:EE:FF(16進数形式でコロンで区切られた数)として文字列で返します。

構文

MACNumToString(num)

MACStringToNum

MACNumToStringの逆関数です。MACアドレスが無効な形式の場合、0を返します。

構文

MACStringToNum(s)

MACStringToOUI

AA:BB:CC:DD:EE:FF形式のMACアドレスを受け取り、最初の3オクテットをUInt64の数として返します。MACアドレスが無効な形式の場合、0を返します。

構文

MACStringToOUI(s)

getSizeOfEnumType

Enumのフィールド数を返します。 型がEnumでない場合は例外がスローされます。

構文

getSizeOfEnumType(value)

引数:

  • valueEnum型の値。

返される値

  • Enum入力値を持つフィールドの数。

SELECT getSizeOfEnumType( CAST('a' AS Enum8('a' = 1, 'b' = 2) ) ) AS x
┌─x─┐
│ 2 │
└───┘

blockSerializedSize

圧縮を考慮せずにディスク上のサイズを返します。

blockSerializedSize(value[, value[, ...]])

引数

  • value — 任意の値。

返される値

  • 圧縮なしでブロック値がディスクに書き込まれるバイト数。

クエリ:

SELECT blockSerializedSize(maxState(1)) AS x

結果:

┌─x─┐
│ 2 │
└───┘

toColumnTypeName

値を表すデータ型の内部名を返します。

構文

toColumnTypeName(value)

引数:

  • value — 任意の型の値。

返される値

  • valueを表すのに使用される内部データ型名。

toTypeNametoColumnTypeNameの違い:

SELECT toTypeName(CAST('2018-01-01 01:02:03' AS DateTime))

結果:

┌─toTypeName(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ DateTime                                            │
└─────────────────────────────────────────────────────┘

クエリ:

SELECT toColumnTypeName(CAST('2018-01-01 01:02:03' AS DateTime))

結果:

┌─toColumnTypeName(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ Const(UInt32)                                             │
└───────────────────────────────────────────────────────────┘

この例は、DateTimeデータ型が内部的にはConst(UInt32)として保存されていることを示しています。

dumpColumnStructure

RAM内のデータ構造の詳細な説明を出力します。

dumpColumnStructure(value)

引数:

  • value — 任意の型の値。

返される値

  • valueを表すために使用されるカラム構造の説明。

SELECT dumpColumnStructure(CAST('2018-01-01 01:02:03', 'DateTime'))
┌─dumpColumnStructure(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ DateTime, Const(size = 1, UInt32(size = 1))                  │
└──────────────────────────────────────────────────────────────┘

defaultValueOfArgumentType

指定されたデータ型のデフォルト値を返します。

ユーザーが設定したカスタムカラムのデフォルト値は含まれません。

構文

defaultValueOfArgumentType(expression)

引数:

  • expression — 任意の型の値または任意の型の値を生成する式。

返される値

  • 数字の場合は0
  • 文字列の場合は空文字列。
  • Nullableの場合はᴺᵁᴸᴸ

クエリ:

SELECT defaultValueOfArgumentType( CAST(1 AS Int8) )

結果:

┌─defaultValueOfArgumentType(CAST(1, 'Int8'))─┐
│                                           0 │
└─────────────────────────────────────────────┘

クエリ:

SELECT defaultValueOfArgumentType( CAST(1 AS Nullable(Int8) ) )

結果:

┌─defaultValueOfArgumentType(CAST(1, 'Nullable(Int8)'))─┐
│                                                  ᴺᵁᴸᴸ │
└───────────────────────────────────────────────────────┘

defaultValueOfTypeName

指定された型名のデフォルト値を返します。

ユーザーが設定したカスタムカラムのデフォルト値は含まれません。

defaultValueOfTypeName(type)

引数:

  • type — 型名を表す文字列。

返される値

  • 数字の場合は0
  • 文字列の場合は空文字列。
  • Nullableの場合はᴺᵁᴸᴸ

クエリ:

SELECT defaultValueOfTypeName('Int8')

結果:

┌─defaultValueOfTypeName('Int8')─┐
│                              0 │
└────────────────────────────────┘

クエリ:

SELECT defaultValueOfTypeName('Nullable(Int8)')

結果:

┌─defaultValueOfTypeName('Nullable(Int8)')─┐
│                                     ᴺᵁᴸᴸ │
└──────────────────────────────────────────┘

indexHint

この関数はデバッグとイントロスペクションを目的としています。引数を無視して常に1を返します。引数は評価されません。

しかし、インデックス分析中、この関数の引数はindexHintでラップされていないものと見なされます。これにより、条件に基づいてインデックス範囲でデータを選択できますが、この条件によるさらなるフィルタリングはできません。ClickHouseのインデックスはスパースであり、indexHintを使用すると、同じ条件を直接指定するよりも多くのデータが得られます。

構文

SELECT * FROM table WHERE indexHint(<expression>)

返される値

テーブル ontime からのテストデータの例を以下に示します。

テーブル:

SELECT count() FROM ontime
┌─count()─┐
│ 4276457 │
└─────────┘

テーブルにはフィールド (FlightDate, (Year, FlightDate)) にインデックスがあります。

インデックスを使用しないクエリを作成します:

SELECT FlightDate AS k, count() FROM ontime GROUP BY k ORDER BY k

ClickHouseはテーブル全体を処理しました(4.28百万行を処理しました)。

結果:

┌──────────k─┬─count()─┐
│ 2017-01-01 │   13970 │
│ 2017-01-02 │   15882 │
........................
│ 2017-09-28 │   16411 │
│ 2017-09-29 │   16384 │
│ 2017-09-30 │   12520 │
└────────────┴─────────┘

インデックスを適用するには、特定の日付を選択します:

SELECT FlightDate AS k, count() FROM ontime WHERE k = '2017-09-15' GROUP BY k ORDER BY k

ClickHouseは現在、より少ない行数を処理するためにインデックスを使用しています(32.74千行を処理しました)。

結果:

┌──────────k─┬─count()─┐
│ 2017-09-15 │   16428 │
└────────────┴─────────┘

現在、式 k = '2017-09-15'indexHint関数でラップします:

クエリ:

SELECT
    FlightDate AS k,
    count()
FROM ontime
WHERE indexHint(k = '2017-09-15')
GROUP BY k
ORDER BY k ASC

ClickHouseは、以前と同様にインデックスを使用しました(32.74千行を処理しました)。 結果を生成する際に、式 k = '2017-09-15' は使用されませんでした。 この例では、indexHint関数は隣接する日付を見ることを可能にします。

結果:

┌──────────k─┬─count()─┐
│ 2017-09-14 │    7071 │
│ 2017-09-15 │   16428 │
│ 2017-09-16 │    1077 │
│ 2017-09-30 │    8167 │
└────────────┴─────────┘

replicate

単一の値を持つ配列を作成します。

注記

この関数は、arrayJoinの内部実装に使用されます。

構文

replicate(x, arr)

引数

  • x — 結果配列に埋め込む値。
  • arr — 配列。Array

返される値

arrと同じ長さの配列で、値xで埋められます。Array

クエリ:

SELECT replicate(1, ['a', 'b', 'c']);

結果:

┌─replicate(1, ['a', 'b', 'c'])─┐
│ [1,1,1]                       │
└───────────────────────────────┘

revision

現在のClickHouse サーバーリビジョンを返します。

構文

revision()

返される値

  • 現在のClickHouseサーバーリビジョン。UInt32

クエリ:

SELECT revision();

結果:

┌─revision()─┐
│      54485 │
└────────────┘

filesystemAvailable

データベースの永続性をホストするファイルシステムの空き容量を返します。返される値は、必ずファイルシステムの総空き容量(filesystemUnreserved)よりも小さく、オペレーティングシステムのための空間が予約されているためです。

構文

filesystemAvailable()

返される値

  • バイト単位での残りの空間の量。UInt64

クエリ:

SELECT formatReadableSize(filesystemAvailable()) AS "Available space";

結果:

┌─Available space─┐
│ 30.75 GiB       │
└─────────────────┘

filesystemUnreserved

データベースの永続性をホストするファイルシステムの総空きスペースを返します。(以前の filesystemFree)。 さらに filesystemAvailable も参照してください。

構文

filesystemUnreserved()

返される値

  • バイト単位での空きスペースの量。UInt64

クエリ:

SELECT formatReadableSize(filesystemUnreserved()) AS "Free space";

結果:

┌─Free space─┐
│ 32.39 GiB  │
└────────────┘

filesystemCapacity

ファイルシステムの容量をバイト単位で返します。データディレクトリへのパスを設定する必要があります。

構文

filesystemCapacity()

返される値

  • バイト単位のファイルシステムの容量。UInt64

クエリ:

SELECT formatReadableSize(filesystemCapacity()) AS "Capacity";

結果:

┌─Capacity──┐
│ 39.32 GiB │
└───────────┘

initializeAggregation

単一の値に基づいて集約関数の結果を計算します。この関数は、-State を使用して集約関数を初期化するために使用できます。集約関数の状態を作成し、AggregateFunction型のカラムに挿入するか、初期化された集約をデフォルト値として使用できます。

構文

initializeAggregation (aggregate_function, arg1, arg2, ..., argN)

引数

  • aggregate_function — 初期化する集約関数の名前。String
  • arg — 集約関数の引数。

返される値

  • 関数に渡された各行の集約結果。

返される型は、initializeAggregationが最初の引数として受け取る関数の返り値と同じです。

クエリ:

SELECT uniqMerge(state) FROM (SELECT initializeAggregation('uniqState', number % 3) AS state FROM numbers(10000));

結果:

┌─uniqMerge(state)─┐
│                3 │
└──────────────────┘

クエリ:

SELECT finalizeAggregation(state), toTypeName(state) FROM (SELECT initializeAggregation('sumState', number % 3) AS state FROM numbers(5));

結果:

┌─finalizeAggregation(state)─┬─toTypeName(state)─────────────┐
│                          0 │ AggregateFunction(sum, UInt8) │
│                          1 │ AggregateFunction(sum, UInt8) │
│                          2 │ AggregateFunction(sum, UInt8) │
│                          0 │ AggregateFunction(sum, UInt8) │
│                          1 │ AggregateFunction(sum, UInt8) │
└────────────────────────────┴───────────────────────────────┘

AggregatingMergeTree テーブルエンジンと AggregateFunctionカラムの例:

CREATE TABLE metrics
(
    key UInt64,
    value AggregateFunction(sum, UInt64) DEFAULT initializeAggregation('sumState', toUInt64(0))
)
ENGINE = AggregatingMergeTree
ORDER BY key
INSERT INTO metrics VALUES (0, initializeAggregation('sumState', toUInt64(42)))

参照

finalizeAggregation

集約関数の状態を与えると、この関数は集約の結果(または-State コンビネータを使用した最終状態)を返します。

構文

finalizeAggregation(state)

引数

返される値

  • 集約された値。
注記

返される型は、集約された任意の型のものと等しいです。

クエリ:

SELECT finalizeAggregation(( SELECT countState(number) FROM numbers(10)));

結果:

┌─finalizeAggregation(_subquery16)─┐
│                               10 │
└──────────────────────────────────┘

クエリ:

SELECT finalizeAggregation(( SELECT sumState(number) FROM numbers(10)));

結果:

┌─finalizeAggregation(_subquery20)─┐
│                               45 │
└──────────────────────────────────┘

NULL値は無視されることに注意してください。

クエリ:

SELECT finalizeAggregation(arrayReduce('anyState', [NULL, 2, 3]));

結果:

┌─finalizeAggregation(arrayReduce('anyState', [NULL, 2, 3]))─┐
│                                                          2 │
└────────────────────────────────────────────────────────────┘

統合例:

クエリ:

WITH initializeAggregation('sumState', number) AS one_row_sum_state
SELECT
    number,
    finalizeAggregation(one_row_sum_state) AS one_row_sum,
    runningAccumulate(one_row_sum_state) AS cumulative_sum
FROM numbers(10);

結果:

┌─number─┬─one_row_sum─┬─cumulative_sum─┐
│      0 │           0 │              0 │
│      1 │           1 │              1 │
│      2 │           2 │              3 │
│      3 │           3 │              6 │
│      4 │           4 │             10 │
│      5 │           5 │             15 │
│      6 │           6 │             21 │
│      7 │           7 │             28 │
│      8 │           8 │             36 │
│      9 │           9 │             45 │
└────────┴─────────────┴────────────────┘

参照

runningAccumulate

各データブロックの行ごとに集約関数の状態を累積します。

注記

状態は各新しいデータブロックごとにリセットされます。 このエラープローンな動作のため、この関数は非推奨となっていますので、適切なウィンドウ関数を使用してください。

構文

runningAccumulate(agg_state[, grouping]);

引数

  • agg_state — 集約関数の状態。AggregateFunction
  • grouping — グルーピングキー。オプション。grouping の値が変わると関数の状態がリセットされます。等価演算子が定義されたサポートされるデータ型のいずれかになります。

返される値

  • 各結果行には、累積された集約関数の結果が含まれ、0から現在の位置までのすべての入力行に対して累積されます。runningAccumulateは、各新しいデータブロックまたはgroupingの値が変わると状態をリセットします。

型は、使用する集約関数によって異なります。

グルーピングなしとグルーピングありでの数の累積和を求めるためにrunningAccumulateをどのように使用できるかを考えます。

クエリ:

SELECT k, runningAccumulate(sum_k) AS res FROM (SELECT number AS k, sumState(k) AS sum_k FROM numbers(10) GROUP BY k ORDER BY k);

結果:

┌─k─┬─res─┐
│ 0 │   0 │
│ 1 │   1 │
│ 2 │   3 │
│ 3 │   6 │
│ 4 │  10 │
│ 5 │  15 │
│ 6 │  21 │
│ 7 │  28 │
│ 8 │  36 │
│ 9 │  45 │
└───┴─────┘

サブクエリは、0から9までの各数のためにsumStateを生成します。sumStateは、単一の数の合計を含むsum関数の状態を返します。

全体のクエリは次のことを行います:

  1. 最初の行のために、runningAccumulatesumState(0)を取得し、0を返します。
  2. 2行目のために、関数はsumState(0)sumState(1)をマージし、sumState(0 + 1)を生成し、1を結果として返します。
  3. 3行目のために、関数はsumState(0 + 1)sumState(2)をマージし、sumState(0 + 1 + 2)を生成し、3を結果として返します。
  4. このアクションはブロックが終了するまで繰り返されます。

以下の例はgrouppingパラメータの使用を示します。

クエリ:

SELECT
    grouping,
    item,
    runningAccumulate(state, grouping) AS res
FROM
(
    SELECT
        toInt8(number / 4) AS grouping,
        number AS item,
        sumState(number) AS state
    FROM numbers(15)
    GROUP BY item
    ORDER BY item ASC
);

結果:

┌─grouping─┬─item─┬─res─┐
│        0 │    0 │   0 │
│        0 │    1 │   1 │
│        0 │    2 │   3 │
│        0 │    3 │   6 │
│        1 │    4 │   4 │
│        1 │    5 │   9 │
│        1 │    6 │  15 │
│        1 │    7 │  22 │
│        2 │    8 │   8 │
│        2 │    9 │  17 │
│        2 │   10 │  27 │
│        2 │   11 │  38 │
│        3 │   12 │  12 │
│        3 │   13 │  25 │
│        3 │   14 │  39 │
└──────────┴──────┴─────┘

ご覧のとおり、runningAccumulateは各行のグループのために状態を別々にマージします。

joinGet

この関数は、辞書と同様にテーブルからデータを抽出することを可能にします。指定された結合キーを使用してJoinテーブルからデータを取得します。

注記

ENGINE = Join(ANY, LEFT, <join_keys>) ステートメントで作成されたテーブルのみをサポートします。

構文

joinGet(join_storage_table_name, `value_column`, join_keys)

引数

  • join_storage_table_name — 検索を行う場所を示す識別子
  • value_column — 必要なデータを含むテーブルのカラム名。
  • join_keys — キーのリスト。
注記

識別子はデフォルトデータベースで検索されます(設定ファイルのdefault_databaseを参照)。デフォルトのデータベースを上書きするには、USE db_name を使用するか、例のように区切り文字 db_name.db_table を通じてデータベースとテーブルを指定します。

返される値

  • キーのリストに対応する値のリストを返します。
注記

特定のキーがソーステーブルに存在しない場合、join_use_nulls設定に基づいて0またはnullが返されます。 join_use_nullsについての詳細は、Join操作を参照してください。

入力テーブル:

CREATE DATABASE db_test;
CREATE TABLE db_test.id_val(`id` UInt32, `val` UInt32) ENGINE = Join(ANY, LEFT, id);
INSERT INTO db_test.id_val VALUES (1, 11)(2, 12)(4, 13);
SELECT * FROM db_test.id_val;
┌─id─┬─val─┐
│  4 │  13 │
│  2 │  12 │
│  1 │  11 │
└────┴─────┘

クエリ:

SELECT number, joinGet(db_test.id_val, 'val', toUInt32(number)) FROM numbers(4);

結果:

   ┌─number─┬─joinGet('db_test.id_val', 'val', toUInt32(number))─┐
1. │      0 │                                                  0 │
2. │      1 │                                                 11 │
3. │      2 │                                                 12 │
4. │      3 │                                                  0 │
   └────────┴────────────────────────────────────────────────────┘

テーブル作成時にjoin_use_nulls設定を使用して、ソーステーブルにキーが存在しない場合の返される動作を変更できます。

CREATE DATABASE db_test;
CREATE TABLE db_test.id_val_nulls(`id` UInt32, `val` UInt32) ENGINE = Join(ANY, LEFT, id) SETTINGS join_use_nulls=1;
INSERT INTO db_test.id_val_nulls VALUES (1, 11)(2, 12)(4, 13);
SELECT * FROM db_test.id_val_nulls;
┌─id─┬─val─┐
│  4 │  13 │
│  2 │  12 │
│  1 │  11 │
└────┴─────┘

クエリ:

SELECT number, joinGet(db_test.id_val_nulls, 'val', toUInt32(number)) FROM numbers(4);

結果:

   ┌─number─┬─joinGet('db_test.id_val_nulls', 'val', toUInt32(number))─┐
1. │      0 │                                                     ᴺᵁᴸᴸ │
2. │      1 │                                                       11 │
3. │      2 │                                                       12 │
4. │      3 │                                                     ᴺᵁᴸᴸ │
   └────────┴──────────────────────────────────────────────────────────┘

joinGetOrNull

joinGet のようですが、キーが欠落している場合にデフォルト値を返すのではなく NULL を返します。

構文

joinGetOrNull(join_storage_table_name, `value_column`, join_keys)

引数

  • join_storage_table_name — 検索を行う場所を示す識別子
  • value_column — 必要なデータを含むテーブルのカラム名。
  • join_keys — キーのリスト。
注記

識別子はデフォルトデータベースで検索されます(設定ファイルのdefault_databaseを参照)。デフォルトのデータベースを上書きするには、USE db_name を使用するか、例のように区切り文字 db_name.db_table を通じてデータベースとテーブルを指定します。

返される値

  • キーのリストに対応する値のリストを返します。
注記

特定のキーがソーステーブルに存在しない場合、そのキーに対してNULLが返されます。

入力テーブル:

CREATE DATABASE db_test;
CREATE TABLE db_test.id_val(`id` UInt32, `val` UInt32) ENGINE = Join(ANY, LEFT, id);
INSERT INTO db_test.id_val VALUES (1, 11)(2, 12)(4, 13);
SELECT * FROM db_test.id_val;
┌─id─┬─val─┐
│  4 │  13 │
│  2 │  12 │
│  1 │  11 │
└────┴─────┘

クエリ:

SELECT number, joinGetOrNull(db_test.id_val, 'val', toUInt32(number)) FROM numbers(4);

結果:

   ┌─number─┬─joinGetOrNull('db_test.id_val', 'val', toUInt32(number))─┐
1. │      0 │                                                     ᴺᵁᴸᴸ │
2. │      1 │                                                       11 │
3. │      2 │                                                       12 │
4. │      3 │                                                     ᴺᵁᴸᴸ │
   └────────┴──────────────────────────────────────────────────────────┘

catboostEvaluate

Not supported in ClickHouse Cloud
注記

この関数はClickHouse Cloudでは利用できません。

外部のcatboostモデルを評価します。CatBoostは、Yandexによって開発された機械学習のためのオープンソースの勾配ブースティングライブラリです。 catboostモデルへのパスとモデル引数(特徴量)を受け取り、Float64を返します。

構文

catboostEvaluate(path_to_model, feature_1, feature_2, ..., feature_n)

SELECT feat1, ..., feat_n, catboostEvaluate('/path/to/model.bin', feat_1, ..., feat_n) AS prediction
FROM data_table

前提条件

  1. catboost評価ライブラリをビルドする

catboostモデルを評価する前に、libcatboostmodel.<so|dylib> ライブラリを利用できるようにする必要があります。どのようにコンパイルするかについては、CatBoostのドキュメントを参照してください。

次に、clickhouse設定でlibcatboostmodel.<so|dylib>のパスを指定します:

<clickhouse>
...
    <catboost_lib_path>/path/to/libcatboostmodel.so</catboost_lib_path>
...
</clickhouse>

セキュリティと隔離の理由から、モデル評価はサーバープロセス内ではなく、clickhouse-library-bridgeプロセス内で実行されます。 catboostEvaluate() の初回実行時に、サーバーはライブラリブリッジプロセスを起動します(まだ実行されていない場合)。両方のプロセスはHTTPインターフェースを使用して通信します。デフォルトでは、ポート9012が使用されます。ポート9012がすでに他のサービスに割り当てられている場合は、次のように別のポートを指定できます。

<library_bridge>
    <port>9019</port>
</library_bridge>
  1. libcatboostを使用してcatboostモデルを訓練する

トレーニングデータセットからcatboostモデルを訓練する方法については、モデルの訓練と適用を参照してください。

throwIf

引数xが真を返す場合、例外をスローします。

構文

throwIf(x[, message[, error_code]])

引数

  • x - チェックする条件。
  • message - カスタムエラーメッセージを提供する定数文字列。オプション。
  • error_code - カスタムエラーコードを提供する定数整数。オプション。

error_code引数を使用するには、設定パラメータallow_custom_error_code_in_throwifを有効にする必要があります。

クエリ:

SELECT throwIf(number = 3, 'Too many') FROM numbers(10);

結果:

↙ Progress: 0.00 rows, 0.00 B (0.00 rows/s., 0.00 B/s.) Received exception from server (version 19.14.1):
Code: 395. DB::Exception: Received from localhost:9000. DB::Exception: Too many.

identity

その引数を返します。デバッグとテストを目的としています。インデックスの使用をキャンセルし、フルスキャンのクエリパフォーマンスを取得します。クエリがインデックスの使用を可能にするために分析されるとき、アナライザーはidentity関数内のすべてを無視します。定数畳み込みも無効になります。

構文

identity(x)

クエリ:

SELECT identity(42);

結果:

┌─identity(42)─┐
│           42 │
└──────────────┘

getSetting

現在のカスタム設定の値を返します。

構文

getSetting('custom_setting');

引数

  • custom_setting — 設定名。String

返される値

  • 設定の現在の値。

クエリ:

SET custom_a = 123;
SELECT getSetting('custom_a');

結果:

123

参照

getSettingOrDefault

現在のカスタム設定の値を返すか、カスタム設定が現在のプロファイルに設定されていない場合は第2引数で指定されたデフォルト値を返します。

構文

getSettingOrDefault('custom_setting', default_value);

引数

  • custom_setting — 設定名。String
  • default_value — custom_settingが設定されていない場合に返す値。値は任意のデータ型またはNullであっても構いません。

返される値

  • 設定の現在の値、または設定が設定されていない場合はdefault_value。

クエリ:

SELECT getSettingOrDefault('custom_undef1', 'my_value');
SELECT getSettingOrDefault('custom_undef2', 100);
SELECT getSettingOrDefault('custom_undef3', NULL);

結果:

my_value
100
NULL

参照

isDecimalOverflow

Decimal値がその精度の範囲外であるか、指定された精度の範囲外であるかどうかを確認します。

構文

isDecimalOverflow(d, [p])

引数

  • d — 値。Decimal
  • p — 精度。オプション。省略すると、最初の引数の初期精度が使用されます。このパラメータは、別のデータベースまたはファイルからデータを移行するのに役立ちます。UInt8

返される値

  • 1 — Decimal値がその精度によって許可されるよりも多くの桁を持つ。
  • 0 — Decimal値が指定された精度を満たしている。

クエリ:

SELECT isDecimalOverflow(toDecimal32(1000000000, 0), 9),
       isDecimalOverflow(toDecimal32(1000000000, 0)),
       isDecimalOverflow(toDecimal32(-1000000000, 0), 9),
       isDecimalOverflow(toDecimal32(-1000000000, 0));

結果:

1    1    1    1

countDigits

値を表すために必要な10進桁の数を返します。

構文

countDigits(x)

引数

返される値

注記

Decimal値については、そのスケールを考慮に入れます: ベースとなる整数型に対して(value * scale)で計算します。例えば: countDigits(42) = 2countDigits(42.000) = 5countDigits(0.04200) = 4。すなわち、Decimal64に対して、countDecimal(x) > 18で小数オーバーフローを確認できます。これは、isDecimalOverflowの遅いバリアントです。

クエリ:

SELECT countDigits(toDecimal32(1, 9)), countDigits(toDecimal32(-1, 9)),
       countDigits(toDecimal64(1, 18)), countDigits(toDecimal64(-1, 18)),
       countDigits(toDecimal128(1, 38)), countDigits(toDecimal128(-1, 38));

結果:

10    10    19    19    39    39

errorCodeToName

構文

errorCodeToName(1)

結果:

UNSUPPORTED_METHOD

tcpPort

このサーバーがリッスンしている ネイティブインターフェース のTCPポート番号を返します。 分散テーブルのコンテキストで実行されると、この関数は各シャードに関連する値を持つ通常のカラムを生成します。それ以外の場合は定数値を生成します。

構文

tcpPort()

引数

  • なし。

返される値

  • TCPポート番号。UInt16

クエリ:

SELECT tcpPort();

結果:

┌─tcpPort()─┐
│      9000 │
└───────────┘

参照

currentProfiles

現在のユーザーの現在の設定プロファイルのリストを返します。

SET PROFILEコマンドを使用して、現在の設定プロファイルを変更できます。SET PROFILEコマンドが使用されていない場合、関数は現在のユーザー定義で指定されたプロファイルを返します(CREATE USERを参照)。

構文

currentProfiles()

返される値

  • 現在のユーザー設定プロファイルのリスト。Array(String).

enabledProfiles

現在のユーザーに明示的および暗黙的に割り当てられた設定プロファイルを返します。明示的に割り当てられたプロファイルは、currentProfiles関数とは同じです。暗黙的に割り当てられたプロファイルには、他の割り当てられたプロファイルの親プロファイル、付与されたロールを通じて割り当てられたプロファイル、独自の設定を通じて割り当てられたプロファイル、および主なデフォルトプロファイル(メインサーバー設定ファイルの default_profileセクションを参照)を含みます。

構文

enabledProfiles()

返される値

  • 有効な設定プロファイルのリスト。Array(String).

defaultProfiles

現在のユーザー定義で指定されたすべてのプロファイルを返します(CREATE USERステートメントを参照)。

構文

defaultProfiles()

返される値

  • デフォルト設定プロファイルのリスト。Array(String).

currentRoles

現在のユーザーに割り当てられているロールを返します。ロールはSET ROLEステートメントによって変更できます。SET ROLEステートメントが使用されなかった場合、関数currentRolesdefaultRolesと同じ結果を返します。

構文

currentRoles()

返される値

  • 現在のユーザーの現在のロールのリスト。Array(String).

enabledRoles

現在のロールとそれに付与されたロールの名前を返します。

構文

enabledRoles()

返される値

  • 現在のユーザーの有効なロールのリスト。Array(String).

defaultRoles

ユーザーがログインしたときにデフォルトで有効なロールを返します。これらは最初は、現在のユーザーに付与されたすべてのロールです(GRANTを参照)が、SET DEFAULT ROLE ステートメントで変更できます。

構文

defaultRoles()

返される値

  • 現在のユーザーに対するデフォルトのロールのリスト。Array(String).

getServerPort

サーバーポート番号を返します。このポートがサーバーによって使用されていない場合、例外が発生します。

構文

getServerPort(port_name)

引数

  • port_name — サーバーポートの名前。String。可能な値:

    • 'tcp_port'
    • 'tcp_port_secure'
    • 'http_port'
    • 'https_port'
    • 'interserver_http_port'
    • 'interserver_https_port'
    • 'mysql_port'
    • 'postgresql_port'
    • 'grpc_port'
    • 'prometheus.port'

返される値

  • サーバーポートの数。UInt16

クエリ:

SELECT getServerPort('tcp_port');

結果:

┌─getServerPort('tcp_port')─┐
│ 9000                      │
└───────────────────────────┘

queryID

現在のクエリのIDを返します。クエリの他のパラメータは、query_idを介してsystem.query_logテーブルから抽出できます。

initialQueryID関数とは異なり、queryIDは異なるシャードで異なる結果を返す場合があります(例を参照)。

構文

queryID()

返される値

  • 現在のクエリのID。String

クエリ:

CREATE TABLE tmp (str String) ENGINE = Log;
INSERT INTO tmp (*) VALUES ('a');
SELECT count(DISTINCT t) FROM (SELECT queryID() AS t FROM remote('127.0.0.{1..3}', currentDatabase(), 'tmp') GROUP BY queryID());

結果:

┌─count()─┐
│ 3       │
└─────────┘

initialQueryID

初期の現在のクエリのIDを返します。クエリの他のパラメータは、initial_query_idを介してsystem.query_logテーブルから抽出できます。

queryID関数とは異なり、initialQueryIDは異なるシャードで同じ結果を返します(例を参照)。

構文

initialQueryID()

返される値

  • 初期の現在のクエリのID。String

クエリ:

CREATE TABLE tmp (str String) ENGINE = Log;
INSERT INTO tmp (*) VALUES ('a');
SELECT count(DISTINCT t) FROM (SELECT initialQueryID() AS t FROM remote('127.0.0.{1..3}', currentDatabase(), 'tmp') GROUP BY queryID());

結果:

┌─count()─┐
│ 1       │
└─────────┘

initialQueryStartTime

初期の現在のクエリの開始時刻を返します。

initialQueryStartTimeは異なるシャードで同じ結果を返します(例を参照)。

構文

initialQueryStartTime()

返される値

  • 初期の現在のクエリの開始時刻。DateTime

クエリ:

CREATE TABLE tmp (str String) ENGINE = Log;
INSERT INTO tmp (*) VALUES ('a');
SELECT count(DISTINCT t) FROM (SELECT initialQueryStartTime() AS t FROM remote('127.0.0.{1..3}', currentDatabase(), 'tmp') GROUP BY queryID());

結果:

┌─count()─┐
│ 1       │
└─────────┘

partitionID

パーティションIDを計算します。

注記

この関数は遅く、大量の行に対して呼び出すべきではありません。

構文

partitionID(x[, y, ...]);

引数

  • x — パーティションIDを返すカラム。
  • y, ... — パーティションIDを返すための残りのNカラム(オプション)。

返される値

  • 行が属するパーティションID。String

クエリ:

DROP TABLE IF EXISTS tab;

CREATE TABLE tab
(
  i int,
  j int
)
ENGINE = MergeTree
PARTITION BY i
ORDER BY tuple();

INSERT INTO tab VALUES (1, 1), (1, 2), (1, 3), (2, 4), (2, 5), (2, 6);

SELECT i, j, partitionID(i), _partition_id FROM tab ORDER BY i, j;

結果:

┌─i─┬─j─┬─partitionID(i)─┬─_partition_id─┐
│ 1 │ 1 │ 1              │ 1             │
│ 1 │ 2 │ 1              │ 1             │
│ 1 │ 3 │ 1              │ 1             │
└───┴───┴────────────────┴───────────────┘
┌─i─┬─j─┬─partitionID(i)─┬─_partition_id─┐
│ 2 │ 4 │ 2              │ 2             │
│ 2 │ 5 │ 2              │ 2             │
│ 2 │ 6 │ 2              │ 2             │
└───┴───┴────────────────┴───────────────┘

shardNum

分散クエリでデータの一部を処理するシャードのインデックスを返します。インデックスは 1 から始まります。クエリが分散されていない場合は、定数値 0 が返されます。

構文

shardNum()

返される値

  • シャードインデックスまたは定数 0UInt32

以下の例では、2つのシャードを持つ構成が使用されます。クエリはすべてのシャードで system.one テーブルに対して実行されます。

クエリ:

CREATE TABLE shard_num_example (dummy UInt8)
    ENGINE=Distributed(test_cluster_two_shards_localhost, system, one, dummy);
SELECT dummy, shardNum(), shardCount() FROM shard_num_example;

結果:

┌─dummy─┬─shardNum()─┬─shardCount()─┐
│     0 │          2 │            2 │
│     0 │          1 │            2 │
└───────┴────────────┴──────────────┘

関連項目

shardCount

分散クエリのシャードの総数を返します。クエリが分散されていない場合は、定数値 0 が返されます。

構文

shardCount()

返される値

  • シャードの総数または 0UInt32

関連項目

  • shardNum() 関数の例には、shardCount() 関数呼び出しも含まれています。

getOSKernelVersion

現在のOSカーネルバージョンを含む文字列を返します。

構文

getOSKernelVersion()

引数

  • なし。

返される値

  • 現在のOSカーネルバージョン。 String

クエリ:

SELECT getOSKernelVersion();

結果:

┌─getOSKernelVersion()────┐
│ Linux 4.15.0-55-generic │
└─────────────────────────┘

zookeeperSessionUptime

現在のZooKeeperセッションの稼働時間(秒)を返します。

構文

zookeeperSessionUptime()

引数

  • なし。

返される値

  • 現在のZooKeeperセッションの稼働時間(秒)。 UInt32

クエリ:

SELECT zookeeperSessionUptime();

結果:

┌─zookeeperSessionUptime()─┐
│                      286 │
└──────────────────────────┘

generateRandomStructure

column1_name column1_type, column2_name column2_type, ... 形式のランダムなテーブル構造を生成します。

構文

generateRandomStructure([number_of_columns, seed])

引数

  • number_of_columns — 結果テーブル構造での希望するカラム数。0または Null に設定された場合、カラム数は1から128の間でランダムになります。デフォルト値: Null
  • seed - 安定した結果を生成するためのランダムシード。シードが指定されていないか、Null に設定された場合は、ランダムに生成されます。

すべての引数は定数でなければなりません。

返される値

  • ランダムに生成されたテーブル構造。 String

クエリ:

SELECT generateRandomStructure()

結果:

┌─generateRandomStructure()─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ c1 Decimal32(5), c2 Date, c3 Tuple(LowCardinality(String), Int128, UInt64, UInt16, UInt8, IPv6), c4 Array(UInt128), c5 UInt32, c6 IPv4, c7 Decimal256(64), c8 Decimal128(3), c9 UInt256, c10 UInt64, c11 DateTime │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

クエリ:

SELECT generateRandomStructure(1)

結果:

┌─generateRandomStructure(1)─┐
│ c1 Map(UInt256, UInt16)    │
└────────────────────────────┘

クエリ:

SELECT generateRandomStructure(NULL, 33)

結果:

┌─generateRandomStructure(NULL, 33)─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ c1 DateTime, c2 Enum8('c2V0' = 0, 'c2V1' = 1, 'c2V2' = 2, 'c2V3' = 3), c3 LowCardinality(Nullable(FixedString(30))), c4 Int16, c5 Enum8('c5V0' = 0, 'c5V1' = 1, 'c5V2' = 2, 'c5V3' = 3), c6 Nullable(UInt8), c7 String, c8 Nested(e1 IPv4, e2 UInt8, e3 UInt16, e4 UInt16, e5 Int32, e6 Map(Date, Decimal256(70))) │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

注意: 複雑な型(Array, Tuple, Map, Nested)の最大ネストの深さは16に制限されています。

この関数は、generateRandom と組み合わせて、完全にランダムなテーブルを生成するために使用できます。

structureToCapnProtoSchema

ClickHouseテーブル構造をCapnProtoスキーマに変換します。

構文

structureToCapnProtoSchema(structure)

引数

  • structurecolumn1_name column1_type, column2_name column2_type, ... 形式のテーブル構造。
  • root_struct_name — CapnProtoスキーマのルート構造体の名前。デフォルト値 - Message

返される値

  • CapnProtoスキーマ。 String

クエリ:

SELECT structureToCapnProtoSchema('column1 String, column2 UInt32, column3 Array(String)') FORMAT RawBLOB

結果:

@0xf96402dd754d0eb7;

struct Message
{
    column1 @0 : Data;
    column2 @1 : UInt32;
    column3 @2 : List(Data);
}

クエリ:

SELECT structureToCapnProtoSchema('column1 Nullable(String), column2 Tuple(element1 UInt32, element2 Array(String)), column3 Map(String, String)') FORMAT RawBLOB

結果:

@0xd1c8320fecad2b7f;

struct Message
{
    struct Column1
    {
        union
        {
            value @0 : Data;
            null @1 : Void;
        }
    }
    column1 @0 : Column1;
    struct Column2
    {
        element1 @0 : UInt32;
        element2 @1 : List(Data);
    }
    column2 @1 : Column2;
    struct Column3
    {
        struct Entry
        {
            key @0 : Data;
            value @1 : Data;
        }
        entries @0 : List(Entry);
    }
    column3 @2 : Column3;
}

クエリ:

SELECT structureToCapnProtoSchema('column1 String, column2 UInt32', 'Root') FORMAT RawBLOB

結果:

@0x96ab2d4ab133c6e1;

struct Root
{
    column1 @0 : Data;
    column2 @1 : UInt32;
}

structureToProtobufSchema

ClickHouseテーブル構造をProtobufスキーマに変換します。

構文

structureToProtobufSchema(structure)

引数

  • structurecolumn1_name column1_type, column2_name column2_type, ... 形式のテーブル構造。
  • root_message_name — Protobufスキーマのルートメッセージの名前。デフォルト値 - Message

返される値

  • Protobufスキーマ。 String

クエリ:

SELECT structureToProtobufSchema('column1 String, column2 UInt32, column3 Array(String)') FORMAT RawBLOB

結果:

syntax = "proto3";

message Message
{
    bytes column1 = 1;
    uint32 column2 = 2;
    repeated bytes column3 = 3;
}

クエリ:

SELECT structureToProtobufSchema('column1 Nullable(String), column2 Tuple(element1 UInt32, element2 Array(String)), column3 Map(String, String)') FORMAT RawBLOB

結果:

syntax = "proto3";

message Message
{
    bytes column1 = 1;
    message Column2
    {
        uint32 element1 = 1;
        repeated bytes element2 = 2;
    }
    Column2 column2 = 2;
    map<string, bytes> column3 = 3;
}

クエリ:

SELECT structureToProtobufSchema('column1 String, column2 UInt32', 'Root') FORMAT RawBLOB

結果:

syntax = "proto3";

message Root
{
    bytes column1 = 1;
    uint32 column2 = 2;
}

formatQuery

指定されたSQLクエリのフォーマットされた、可能性のある複数行版を返します。

クエリが正常に構成されていない場合、例外がスローされます。代わりに NULL を返すためには、関数 formatQueryOrNull() を使用することができます。

構文

formatQuery(query)
formatQueryOrNull(query)

引数

  • query - フォーマットされるSQLクエリ。 String

返される値

  • フォーマットされたクエリ。 String

SELECT formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3');

結果:

┌─formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3')─┐
│ SELECT
    a,
    b
FROM tab
WHERE (a > 3) AND (b < 3)            │
└───────────────────────────────────────────────────────────────┘

formatQuerySingleLine

formatQuery() と同様ですが、返されるフォーマットされた文字列に改行は含まれません。

クエリが正常に構成されていない場合、例外がスローされます。代わりに NULL を返すためには、関数 formatQuerySingleLineOrNull() を使用することができます。

構文

formatQuerySingleLine(query)
formatQuerySingleLineOrNull(query)

引数

  • query - フォーマットされるSQLクエリ。 String

返される値

  • フォーマットされたクエリ。 String

SELECT formatQuerySingleLine('select a,    b FRom tab WHERE a > 3 and  b < 3');

結果:

┌─formatQuerySingleLine('select a,    b FRom tab WHERE a > 3 and  b < 3')─┐
│ SELECT a, b FROM tab WHERE (a > 3) AND (b < 3)                          │
└─────────────────────────────────────────────────────────────────────────┘

variantElement

Variant カラムから指定された型のカラムを抽出します。

構文

variantElement(variant, type_name, [, default_value])

引数

  • variant — Variantカラム。 Variant
  • type_name — 抽出するバリアント型の名前。 String
  • default_value - 指定された型での変種が存在しない場合に使用されるデフォルト値。任意の型が可能。

返される値

  • 指定された型の Variant カラムのサブカラム。

CREATE TABLE test (v Variant(UInt64, String, Array(UInt64))) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT v, variantElement(v, 'String'), variantElement(v, 'UInt64'), variantElement(v, 'Array(UInt64)') FROM test;
┌─v─────────────┬─variantElement(v, 'String')─┬─variantElement(v, 'UInt64')─┬─variantElement(v, 'Array(UInt64)')─┐
│ ᴺᵁᴸᴸ          │ ᴺᵁᴸᴸ                        │                        ᴺᵁᴸᴸ │ []                                 │
│ 42            │ ᴺᵁᴸᴸ                        │                          42 │ []                                 │
│ Hello, World! │ Hello, World!               │                        ᴺᵁᴸᴸ │ []                                 │
│ [1,2,3]       │ ᴺᵁᴸᴸ                        │                        ᴺᵁᴸᴸ │ [1,2,3]                            │
└───────────────┴─────────────────────────────┴─────────────────────────────┴────────────────────────────────────┘

variantType

Variant カラムの各行に対するバリアント型名を返します。行がNULLを含む場合、その行には 'None' が返されます。

構文

variantType(variant)

引数

  • variant — Variantカラム。 Variant

返される値

  • 各行のバリアント型名を含むEnum8カラム。

CREATE TABLE test (v Variant(UInt64, String, Array(UInt64))) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT variantType(v) FROM test;
┌─variantType(v)─┐
│ None           │
│ UInt64         │
│ String         │
│ Array(UInt64)  │
└────────────────┘
SELECT toTypeName(variantType(v)) FROM test LIMIT 1;
┌─toTypeName(variantType(v))──────────────────────────────────────────┐
│ Enum8('None' = -1, 'Array(UInt64)' = 0, 'String' = 1, 'UInt64' = 2) │
└─────────────────────────────────────────────────────────────────────┘

minSampleSizeConversion

二つのサンプルでのコンバージョン(割合)を比較するためのA/Bテストに必要な最小サンプルサイズを計算します。

構文

minSampleSizeConversion(baseline, mde, power, alpha)

このブログ記事で説明されている式を使用します。治療群とコントロール群が等しいサイズであると仮定します。一群に必要なサンプルサイズが返されます(すなわち、全体の実験に必要なサンプルサイズは返された値の2倍です)。

引数

  • baseline — ベースラインコンバージョン。 Float
  • mde — 最小検出可能効果(MDE)をパーセンテージポイントで指定します(例: ベースラインコンバージョンが0.25の場合、MDE 0.03は0.25 ± 0.03 の変化を意味します)。 Float
  • power — テストの必要な統計的パワー(1 - II型誤差の確率)。 Float
  • alpha — テストの必要な有意水準(I型誤差の確率)。 Float

返される値

以下の3つの要素を持つ名前付き Tuple:

  • "minimum_sample_size" — 必要なサンプルサイズ。 Float64
  • "detect_range_lower" — 返された必要なサンプルサイズでは検出できない値の下限(すなわち、"detect_range_lower" 以下のすべての値は、提供された alpha および power で検出可能です)。 baseline - mde として計算されます。 Float64
  • "detect_range_upper" — 返された必要なサンプルサイズでは検出できない値の上限(すなわち、"detect_range_upper" 以上のすべての値は、提供された alpha および power で検出可能です)。 baseline + mde として計算されます。 Float64

次のクエリは、ベースラインコンバージョンが25%、MDEが3%、有意水準が5%、期待される統計的パワーが80%のA/Bテストに必要なサンプルサイズを計算します。

SELECT minSampleSizeConversion(0.25, 0.03, 0.80, 0.05) AS sample_size;

結果:

┌─sample_size───────────────────┐
│ (3396.077603219163,0.22,0.28) │
└───────────────────────────────┘

minSampleSizeContinuous

二つのサンプルでの連続メトリックの平均を比較するためのA/Bテストに必要な最小サンプルサイズを計算します。

構文

minSampleSizeContinous(baseline, sigma, mde, power, alpha)

エイリアス: minSampleSizeContinous

このブログ記事で説明されている式を使用します。治療群とコントロール群が等しいサイズであると仮定します。一群に必要なサンプルサイズが返されます(すなわち、全体の実験に必要なサンプルサイズは返された値の2倍です)。テストメトリックの治療群とコントロール群の分散が等しいと仮定します。

引数

  • baseline — メトリックのベースライン値。 Integer または Float
  • sigma — メトリックのベースライン標準偏差。 Integer または Float
  • mde — ベースライン値のパーセンテージでの最小検出可能効果(MDE)(例: ベースライン値112.25の場合、MDE 0.03は112.25 ± 112.25*0.03 の変化を意味します)。 Integer または Float
  • power — テストの必要な統計的パワー(1 - II型誤差の確率)。 Integer または Float
  • alpha — テストの必要な有意水準(I型誤差の確率)。 Integer または Float

返される値

以下の3つの要素を持つ名前付き Tuple

  • "minimum_sample_size" — 必要なサンプルサイズ。 Float64
  • "detect_range_lower" — 返された必要なサンプルサイズでは検出できない値の下限(すなわち、"detect_range_lower" 以下のすべての値は、提供された alphapower で検出可能です)。 baseline * (1 - mde) として計算されます。 Float64
  • "detect_range_upper" — 返された必要なサンプルサイズでは検出できない値の上限(すなわち、"detect_range_upper" 以上のすべての値は、提供された alphapower で検出可能です)。 baseline * (1 + mde) として計算されます。 Float64

次のクエリは、ベースライン値112.25、標準偏差21.1、MDEが3%、有意水準が5%、期待される統計的パワーが80%のメトリックにおけるA/Bテストに必要なサンプルサイズを計算します。

SELECT minSampleSizeContinous(112.25, 21.1, 0.03, 0.80, 0.05) AS sample_size;

結果:

┌─sample_size───────────────────────────┐
│ (616.2931945826209,108.8825,115.6175) │
└───────────────────────────────────────┘

connectionId

現在のクエリを送信したクライアントの接続IDを取得し、UInt64整数として返します。

構文

connectionId()

エイリアス: connection_id

パラメーター

なし。

返される値

現在の接続ID。 UInt64

実装の詳細

この関数は、デバッグシナリオやMySQLハンドラ内部のために最も便利です。MySQLの CONNECTION_ID 関数との互換性のために作成されました。本番のクエリでは通常使用されません。

クエリ:

SELECT connectionId();

結果:

0

getClientHTTPHeader

HTTPヘッダーの値を取得します。

そのようなヘッダーがない場合や、現在のリクエストがHTTPインターフェースを介して行われていない場合、関数は空の文字列を返します。特定のHTTPヘッダー(例:AuthenticationX-ClickHouse-*)は制限されています。

この関数は、allow_get_client_http_header 設定を有効にする必要があります。この設定はセキュリティ上の理由からデフォルトでは無効になっており、Cookie などのいくつかのヘッダーには機密情報が含まれる可能性があります。

この関数では、HTTPヘッダーはケースセンシティブです。

この関数が分散クエリの文脈で使用される場合、イニシエータノードでのみ非空の結果が返されます。

showCertificate

現在のサーバーのSecure Sockets Layer (SSL) 証明書に関する情報を表示します(設定されている場合)。ClickHouseがOpenSSL証明書を使用して接続を検証する方法についての詳細は、 SSL-TLSの設定 を参照してください。

構文

showCertificate()

返される値

  • 設定されたSSL証明書に関連するキー-バリューのマップ。 Map(String, String)。

クエリ:

SELECT showCertificate() FORMAT LineAsString;

結果:

{'version':'1','serial_number':'2D9071D64530052D48308473922C7ADAFA85D6C5','signature_algo':'sha256WithRSAEncryption','issuer':'/CN=marsnet.local CA','not_before':'May  7 17:01:21 2024 GMT','not_after':'May  7 17:01:21 2025 GMT','subject':'/CN=chnode1','pkey_algo':'rsaEncryption'}

lowCardinalityIndices

LowCardinality カラムの辞書における値の位置を返します。位置は1から始まります。LowCardinalityにはパーツごとの辞書があるため、この関数は同じ値に対して異なるパーツで異なる位置を返す場合があります。

構文

lowCardinalityIndices(col)

引数

返される値

  • 現在のパーツの辞書における値の位置。 UInt64

クエリ:

DROP TABLE IF EXISTS test;
CREATE TABLE test (s LowCardinality(String)) ENGINE = Memory;

-- create two parts:

INSERT INTO test VALUES ('ab'), ('cd'), ('ab'), ('ab'), ('df');
INSERT INTO test VALUES ('ef'), ('cd'), ('ab'), ('cd'), ('ef');

SELECT s, lowCardinalityIndices(s) FROM test;

結果:

   ┌─s──┬─lowCardinalityIndices(s)─┐
1. │ ab │                        1 │
2. │ cd │                        2 │
3. │ ab │                        1 │
4. │ ab │                        1 │
5. │ df │                        3 │
   └────┴──────────────────────────┘
    ┌─s──┬─lowCardinalityIndices(s)─┐
 6. │ ef │                        1 │
 7. │ cd │                        2 │
 8. │ ab │                        3 │
 9. │ cd │                        2 │
10. │ ef │                        1 │
    └────┴──────────────────────────┘

lowCardinalityKeys

LowCardinality カラムの辞書値を返します。ブロックが辞書サイズより小さいか大きい場合、結果は途切れるか、デフォルト値で拡張されます。LowCardinalityにはパーツごとの辞書があるため、この関数は異なるパーツで異なる辞書値を返す場合があります。

構文

lowCardinalityKeys(col)

引数

返される値

クエリ:

DROP TABLE IF EXISTS test;
CREATE TABLE test (s LowCardinality(String)) ENGINE = Memory;

-- create two parts:

INSERT INTO test VALUES ('ab'), ('cd'), ('ab'), ('ab'), ('df');
INSERT INTO test VALUES ('ef'), ('cd'), ('ab'), ('cd'), ('ef');

SELECT s, lowCardinalityKeys(s) FROM test;

結果:

   ┌─s──┬─lowCardinalityKeys(s)─┐
1. │ ef │                       │
2. │ cd │ ef                    │
3. │ ab │ cd                    │
4. │ cd │ ab                    │
5. │ ef │                       │
   └────┴───────────────────────┘
    ┌─s──┬─lowCardinalityKeys(s)─┐
 6. │ ab │                       │
 7. │ cd │ ab                    │
 8. │ ab │ cd                    │
 9. │ ab │ df                    │
10. │ df │                       │
    └────┴───────────────────────┘

displayName

config (/operations/configuration-files) における display_name の値、または設定されていない場合はサーバーの完全修飾ドメイン名 (FQDN) を返します。

構文

displayName()

返される値

  • 設定されている場合は display_name の値、設定されていない場合はサーバーのFQDN。 String

config.xmldisplay_name を設定できます。例えば、'production' に設定されたサーバーを考えてみましょう。

<!-- It is the name that will be shown in the clickhouse-client.
     By default, anything with "production" will be highlighted in red in query prompt.
-->
<display_name>production</display_name>

クエリ:

SELECT displayName();

結果:

┌─displayName()─┐
│ production    │
└───────────────┘

transactionID

Experimental feature. Learn more.
Not supported in ClickHouse Cloud

transaction のIDを返します。

注記

この関数は実験的な機能セットの一部です。実験的なトランザクションサポートを有効にするには、この設定を構成に追加します:

<clickhouse>
  <allow_experimental_transactions>1</allow_experimental_transactions>
</clickhouse>

詳細については、Transactional (ACID) supportのページを参照してください。

構文

transactionID()

返される値

  • start_csn, local_tid および host_id からなるタプルを返します。 Tuple

  • start_csn: グローバル順序番号。このトランザクションが始まったときに見た最新のコミットタイムスタンプ。 UInt64

  • local_tid: このホストによって開始された各トランザクションに対して一意のローカル順序番号。 UInt64

  • host_id: このトランザクションを開始したホストのUUID。 UUID

クエリ:

BEGIN TRANSACTION;
SELECT transactionID();
ROLLBACK;

結果:

┌─transactionID()────────────────────────────────┐
│ (32,34,'0ee8b069-f2bb-4748-9eae-069c85b5252b') │
└────────────────────────────────────────────────┘

transactionLatestSnapshot

Experimental feature. Learn more.
Not supported in ClickHouse Cloud

読み取り可能な transaction の最新のスナップショット(コミットシーケンス番号)を返します。

注記

この関数は実験的な機能セットの一部です。実験的なトランザクションサポートを有効にするには、この設定を構成に追加します:

<clickhouse>
  <allow_experimental_transactions>1</allow_experimental_transactions>
</clickhouse>

詳細については、Transactional (ACID) supportのページを参照してください。

構文

transactionLatestSnapshot()

返される値

  • トランザクションの最新のスナップショット(CSN)を返します。 UInt64

クエリ:

BEGIN TRANSACTION;
SELECT transactionLatestSnapshot();
ROLLBACK;

結果:

┌─transactionLatestSnapshot()─┐
│                          32 │
└─────────────────────────────┘

transactionOldestSnapshot

Experimental feature. Learn more.
Not supported in ClickHouse Cloud

実行中の transaction で可視の最古のスナップショット(コミットシーケンス番号)を返します。

注記

この関数は実験的な機能セットの一部です。実験的なトランザクションサポートを有効にするには、この設定を構成に追加します:

<clickhouse>
  <allow_experimental_transactions>1</allow_experimental_transactions>
</clickhouse>

詳細については、Transactional (ACID) supportのページを参照してください。

構文

transactionOldestSnapshot()

返される値

  • トランザクションの最古のスナップショット(CSN)を返します。 UInt64

クエリ:

BEGIN TRANSACTION;
SELECT transactionLatestSnapshot();
ROLLBACK;

結果:

┌─transactionOldestSnapshot()─┐
│                          32 │
└─────────────────────────────┘

getSubcolumn

テーブル表現または識別子とサブカラム名を持つ定数文字列を受け取り、式から抽出された要求されたサブカラムを返します。

構文

getSubcolumn(col_name, subcol_name)

引数

  • col_name — テーブル表現または識別子。 Expression, Identifier
  • subcol_name — サブカラムの名前。 String

返される値

  • 抽出されたサブカラムを返します。

クエリ:

CREATE TABLE t_arr (arr Array(Tuple(subcolumn1 UInt32, subcolumn2 String))) ENGINE = MergeTree ORDER BY tuple();
INSERT INTO t_arr VALUES ([(1, 'Hello'), (2, 'World')]), ([(3, 'This'), (4, 'is'), (5, 'subcolumn')]);
SELECT getSubcolumn(arr, 'subcolumn1'), getSubcolumn(arr, 'subcolumn2') FROM t_arr;

結果:

   ┌─getSubcolumn(arr, 'subcolumn1')─┬─getSubcolumn(arr, 'subcolumn2')─┐
1. │ [1,2]                           │ ['Hello','World']               │
2. │ [3,4,5]                         │ ['This','is','subcolumn']       │
   └─────────────────────────────────┴─────────────────────────────────┘

getTypeSerializationStreams

データ型のストリームパスを列挙します。

注記

この関数は開発者向けに設計されています。

構文

getTypeSerializationStreams(col)

引数

  • col — データ型を検出するためのカラムまたは文字列表現。

返される値

  • すべてのシリアライズされたサブストリームパスを含む配列を返します。 Array(String)。

クエリ:

SELECT getTypeSerializationStreams(tuple('a', 1, 'b', 2));

結果:

   ┌─getTypeSerializationStreams(('a', 1, 'b', 2))─────────────────────────────────────────────────────────────────────────┐
1. │ ['{TupleElement(1), Regular}','{TupleElement(2), Regular}','{TupleElement(3), Regular}','{TupleElement(4), Regular}'] │
   └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

クエリ:

SELECT getTypeSerializationStreams('Map(String, Int64)');

結果:

   ┌─getTypeSerializationStreams('Map(String, Int64)')────────────────────────────────────────────────────────────────┐
1. │ ['{ArraySizes}','{ArrayElements, TupleElement(keys), Regular}','{ArrayElements, TupleElement(values), Regular}'] │
   └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

globalVariable

定数文字列引数を取得し、その名前のグローバル変数の値を返します。この関数はMySQLとの互換性を目的としており、ClickHouseの通常の操作には必要ないか役立たないものです。定義されているダミーのグローバル変数は少数です。

構文

globalVariable(name)

引数

  • name — グローバル変数名。 String

返される値

  • 変数 name の値を返します。

クエリ:

SELECT globalVariable('max_allowed_packet');

結果:

┌─globalVariable('max_allowed_packet')─┐
│                             67108864 │
└──────────────────────────────────────┘

getMaxTableNameLengthForDatabase

指定されたデータベース内の最大テーブル名の長さを返します。

構文

getMaxTableNameLengthForDatabase(database_name)

引数

  • database_name — 指定されたデータベースの名前。 String

返される値

  • 最大テーブル名の長さを返します。

クエリ:

SELECT getMaxTableNameLengthForDatabase('default');

結果:

┌─getMaxTableNameLengthForDatabase('default')─┐
│                                         206 │
└─────────────────────────────────────────────┘

getServerSetting

サーバー設定の現在の値を返します

構文

getServerSetting('server_setting');

パラメーター

  • server_setting — 設定名。 String

返される値

  • サーバー設定の現在の値。

SELECT getServerSetting('allow_use_jemalloc_memory');

結果:

┌─getServerSetting('allow_use_jemalloc_memory')─┐
│ true                                          │
└───────────────────────────────────────────────┘

getMergeTreeSetting

マージツリー設定の現在の値を返します

構文

getMergeTreeSetting('merge_tree_setting');

パラメーター

  • merge_tree_setting — 設定名。 String

返される値

  • マージツリー設定の現在の値。

SELECT getMergeTreeSetting('index_granularity');

結果:

┌─getMergeTree(index_granularity')─┐
│                     8192         │
└──────────────────────────────────┘