エンコーディング関数

char

渡された引数の数と同じ長さの文字列を返し、それぞれのバイトは対応する引数の値を持ちます。数値型の引数を複数受け入れます。引数の値がUInt8データ型の範囲外の場合は、丸めやオーバーフローの可能性があるUInt8に変換されます。

構文

char(number_1, [number_2, ..., number_n]);

引数

number_1, number_2, ..., number_n — 整数として解釈される数値引数。型: Int, Float。

返される値

指定されたバイトの文字列。String。

例

クエリ：

SELECT char(104.1, 101, 108.9, 108.9, 111) AS hello;

結果：

┌─hello─┐
│ hello │
└───────┘

対応するバイトを渡すことで任意のエンコーディングの文字列を構築できます。以下はUTF-8の例です：

クエリ：

SELECT char(0xD0, 0xBF, 0xD1, 0x80, 0xD0, 0xB8, 0xD0, 0xB2, 0xD0, 0xB5, 0xD1, 0x82) AS hello;

結果：

┌─hello──┐
│ привет │
└────────┘

クエリ：

SELECT char(0xE4, 0xBD, 0xA0, 0xE5, 0xA5, 0xBD) AS hello;

結果：

┌─hello─┐
│ 你好  │
└───────┘

hex

引数の16進数表現を含む文字列を返します。

エイリアス: HEX.

構文

hex(arg)

この関数は大文字の A-F を使用し、プレフィックス（例えば 0x）やサフィックス（例えば h）は使用しません。

整数引数の場合、最上位から最下位まで（ビッグエンディアンまたは「人間が読みやすい」順序）でヘックス数字（「ニブル」）を印刷します。最上位のゼロでないバイトから始まり（リーディングゼロバイトは省略されますが）、常にリーディング数字がゼロでも任意のバイトの両方の数字を印刷します。

Date および DateTime 型の値は対応する整数としてフォーマットされます（Dateの場合、エポックからの日数、DateTimeの場合はUnixタイムスタンプの値）。

String と FixedString の場合、すべてのバイトは単に2つの16進数としてエンコードされます。ゼロバイトは省略されません。

Float および Decimal 型の値は、メモリ内の表現としてエンコードされます。私たちはリトルエンディアンアーキテクチャをサポートしているため、リトルエンディアンでエンコードされます。先頭/末尾のゼロバイトは省略されません。

UUID 型の値は、ビッグエンディアン順の文字列としてエンコードされます。

引数

arg — 16進数に変換する値。型: String, UInt, Float, Decimal, Date または DateTime。

返される値

引数の16進数表現を持つ文字列。String。

例

クエリ：

SELECT hex(1);

結果：

クエリ：

SELECT hex(toFloat32(number)) AS hex_presentation FROM numbers(15, 2);

結果：

┌─hex_presentation─┐
│ 00007041         │
│ 00008041         │
└──────────────────┘

クエリ：

SELECT hex(toFloat64(number)) AS hex_presentation FROM numbers(15, 2);

結果：

┌─hex_presentation─┐
│ 0000000000002E40 │
│ 0000000000003040 │
└──────────────────┘

クエリ：

SELECT lower(hex(toUUID('61f0c404-5cb3-11e7-907b-a6006ad3dba0'))) as uuid_hex

結果：

┌─uuid_hex─────────────────────────┐
│ 61f0c4045cb311e7907ba6006ad3dba0 │
└──────────────────────────────────┘

unhex

hex の逆の操作を実行します。引数の各ペアの16進数数字を数値として解釈し、その数値によって表されるバイトに変換します。返される値はバイナリ文字列（BLOB）です。

結果を数値に変換したい場合は、reverse および reinterpretAs<Type> 関数を使用できます。

注記

unhex が clickhouse-client から呼び出された場合、バイナリ文字列はUTF-8を使用して表示されます。

エイリアス: UNHEX.

構文

unhex(arg)

引数

arg — 任意の数の16進数の数字を含む文字列。String, FixedString。

大文字と小文字の両方の A-F の文字をサポートします。16進数の数字の数は必ずしも偶数ではなくても構いません。奇数の場合は、最後の数字は 00-0F バイトの最下位ビットと解釈されます。引数の文字列に16進数の数字以外のものが含まれている場合は、いくつかの実装定義された結果が返されます（例外はスローされません）。数値引数に対しては、hex(N) の逆はunhex() によって実行されません。

返される値

バイナリ文字列（BLOB）。String。

例

クエリ：

SELECT unhex('303132'), UNHEX('4D7953514C');

結果：

┌─unhex('303132')─┬─unhex('4D7953514C')─┐
│ 012             │ MySQL               │
└─────────────────┴─────────────────────┘

クエリ：

SELECT reinterpretAsUInt64(reverse(unhex('FFF'))) AS num;

結果：

┌─num─┐
│ 4095 │
└──────┘

bin

引数のバイナリ表現を含む文字列を返します。

構文

bin(arg)

エイリアス: BIN.

整数引数の場合、最上位から最下位まで（ビッグエンディアンまたは「人間が読みやすい」順序）でビン数字を印刷します。最上位のゼロでないバイトから始まり（リーディングゼロバイトは省略されますが）、常にリーディング数字がゼロでも任意のバイトの8桁を印刷します。

Date および DateTime 型の値は、対応する整数としてフォーマットされます（Date の場合、エポックからの日数、DateTime の場合はUnixタイムスタンプの値）。

String および FixedString の場合、すべてのバイトは単に8つのバイナリ数としてエンコードされます。ゼロバイトは省略されません。

Float および Decimal 型の値はメモリ内の表現としてエンコードされます。私たちはリトルエンディアンアーキテクチャをサポートしているため、リトルエンディアンでエンコードされます。先頭および末尾のゼロバイトは省略されません。

UUID 型の値は、ビッグエンディアン順の文字列としてエンコードされます。

引数

arg — バイナリに変換する値。String, FixedString, UInt, Float, Decimal, Date, または DateTime。

返される値

引数のバイナリ表現を持つ文字列。String。

例

クエリ：

SELECT bin(14);

結果：

┌─bin(14)──┐
│ 00001110 │
└──────────┘

クエリ：

SELECT bin(toFloat32(number)) AS bin_presentation FROM numbers(15, 2);

結果：

┌─bin_presentation─────────────────┐
│ 00000000000000000111000001000001 │
│ 00000000000000001000000001000001 │
└──────────────────────────────────┘

クエリ：

SELECT bin(toFloat64(number)) AS bin_presentation FROM numbers(15, 2);

結果：

┌─bin_presentation─────────────────────────────────────────────────┐
│ 0000000000000000000000000000000000000000000000000010111001000000 │
│ 0000000000000000000000000000000000000000000000000011000001000000 │
└──────────────────────────────────────────────────────────────────┘

クエリ：

SELECT bin(toUUID('61f0c404-5cb3-11e7-907b-a6006ad3dba0')) as bin_uuid

結果：

┌─bin_uuid─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ 01100001111100001100010000000100010111001011001100010001111001111001000001111011101001100000000001101010110100111101101110100000 │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

unbin

引数の各ペアのバイナリ数字を数値として解釈し、その数値によって表されるバイトに変換します。この関数はbinの逆の操作を実行します。

構文

unbin(arg)

エイリアス: UNBIN.

数値引数に対して unbin() は bin() の逆を返しません。結果を数値に変換したい場合、reverse および reinterpretAs<Type> 関数を使用できます。

注記

unbin が clickhouse-client から呼び出された場合、バイナリ文字列はUTF-8で表示されます。

バイナリ数字 0 と 1 をサポートします。バイナリ数字の数は8の倍数である必要はありません。引数の文字列にバイナリ数字以外のものが含まれている場合はいくつかの実装定義された結果が返されます（例外はスローされません）。

引数

arg — 任意の数のバイナリ数字を含む文字列。String。

返される値

バイナリ文字列（BLOB）。String。

例

クエリ：

SELECT UNBIN('001100000011000100110010'), UNBIN('0100110101111001010100110101000101001100');

結果：

┌─unbin('001100000011000100110010')─┬─unbin('0100110101111001010100110101000101001100')─┐
│ 012                               │ MySQL                                             │
└───────────────────────────────────┴───────────────────────────────────────────────────┘

クエリ：

SELECT reinterpretAsUInt64(reverse(unbin('1110'))) AS num;

結果：

┌─num─┐
│  14 │
└─────┘

bitmaskToList(num)

整数を受け入れます。合計すると元の数に達する2の累乗のリストを含む文字列を返します。テキスト形式でカンマ区切りで、スペースなしで昇順に並べられています。

bitmaskToArray(num)

整数を受け入れます。合計すると元の数に達する2の累乗のリストを含むUInt64の配列を返します。配列内の数値は昇順です。

bitPositionsToArray(num)

整数を受け入れ、符号なし整数に変換します。引数のビットが 1 に等しい位置のリストを含む UInt64 数の配列を返します。

構文

bitPositionsToArray(arg)

引数

arg — 整数値。Int/UInt。

返される値

ビット位置のリストを含む配列、昇順。Array(UInt64)。

例

クエリ：

SELECT bitPositionsToArray(toInt8(1)) AS bit_positions;

結果：

┌─bit_positions─┐
│ [0]           │
└───────────────┘

クエリ：

SELECT bitPositionsToArray(toInt8(-1)) AS bit_positions;

結果：

┌─bit_positions─────┐
│ [0,1,2,3,4,5,6,7] │
└───────────────────┘

mortonEncode

符号なし整数のリストに対するモートンエンコーディング（ZCurve）を計算します。

この関数には2つの操作モードがあります：

シンプル
拡張

シンプルモード

最大8つの符号なし整数を引数として受け取り、UInt64コードを生成します。

構文

mortonEncode(args)

パラメータ

args: 最大8つの符号なし整数または前述の型のカラム。

返される値

UInt64コード。UInt64

例

クエリ：

SELECT mortonEncode(1, 2, 3);

結果：

拡張モード

最初の引数には範囲マスク（タプル）を受け取り、その他の引数には最大8つの符号なし整数を受け取ります。

マスク内の各数は範囲の拡張量を設定します：
1 - 拡張なし
2 - 2倍の拡張
3 - 3倍の拡張
...
最大8倍の拡張。

構文

mortonEncode(range_mask, args)

パラメータ

range_mask: 1-8。
args: 最大8つの符号なし整数または前述の型のカラム。

注意: args のためにカラムを使用する場合でも、提供された range_mask タプルは定数である必要があります。

返される値

UInt64コード。UInt64

例

範囲拡張は、範囲（またはカーディナリティ）が大きく異なる引数に類似の分布が必要な場合に有益です。例えば、「IP アドレス」（0...FFFFFFFF）と「国コード」（0...FF）。

クエリ：

SELECT mortonEncode((1,2), 1024, 16);

結果：

注意: タプルのサイズは他の引数の数に等しくなければなりません。

例

単一の引数に対するモートンエンコーディングは常にその引数自体です：

クエリ：

SELECT mortonEncode(1);

結果：

例

単一の引数を拡張することも可能です：

クエリ：

SELECT mortonEncode(tuple(2), 128);

結果：

例

カラム名を関数に使用することもできます。

クエリ：

まずテーブルを作成してデータを挿入します。

create table morton_numbers(
    n1 UInt32,
    n2 UInt32,
    n3 UInt16,
    n4 UInt16,
    n5 UInt8,
    n6 UInt8,
    n7 UInt8,
    n8 UInt8
)
Engine=MergeTree()
ORDER BY n1 SETTINGS index_granularity = 8192, index_granularity_bytes = '10Mi';
insert into morton_numbers (*) values(1,2,3,4,5,6,7,8);

定数の代わりにカラム名を mortonEncode の引数として使用します。

クエリ：

SELECT mortonEncode(n1, n2, n3, n4, n5, n6, n7, n8) FROM morton_numbers;

結果：

2155374165

実装の詳細

モートンコードには、UInt64 が持つ情報ビット数に制限があることに注意してください。2つの引数は最大2^32（64/2）の範囲を持ち、3つの引数は最大2^21（64/3）の範囲を持つなど、すべてのオーバーフローはゼロに制限されます。

mortonDecode

モートンエンコーディング（ZCurve）をデコードして、対応する符号なし整数のタプルに変換します。

mortonEncode 関数と同様に、この関数にも2つの操作モードがあります：

シンプル
拡張

シンプルモード

結果のタプルサイズを最初の引数として受け取り、コードを2番目の引数として受け取ります。

構文

mortonDecode(tuple_size, code)

パラメータ

tuple_size: 8を超えない整数値。
code: UInt64 コード。

返される値

指定されたサイズのタプル。UInt64

例

クエリ：

SELECT mortonDecode(3, 53);

結果：

["1","2","3"]

拡張モード

最初の引数には範囲マスク（タプル）を受け取り、2番目の引数にはコードを受け取ります。マスク内の各数は範囲の縮小量を設定します：
1 - 縮小なし
2 - 2倍の縮小
3 - 3倍の縮小
...
最大8倍の縮小。

範囲拡張は、範囲（またはカーディナリティ）が大きく異なる引数に類似の分布が必要な場合に有益です。IPアドレス（0...FFFFFFFF）と国コード（0...FF）など、最大8の数に制限されています。

例

モートンコードの単一の引数は常にその引数自体（タプルとして）です：

クエリ：

SELECT mortonDecode(1, 1);

結果：

["1"]

例

単一の引数にタプルが指定され、ビットシフトが指定された場合、関数は指定された数のビットだけ引数を左にシフトします。

クエリ：

SELECT mortonDecode(tuple(2), 32768);

結果：

["128"]

例

この関数も第二引数としてコードのカラムを受け取ります：

最初にテーブルを作成してデータを挿入します。

クエリ：

create table morton_numbers(
    n1 UInt32,
    n2 UInt32,
    n3 UInt16,
    n4 UInt16,
    n5 UInt8,
    n6 UInt8,
    n7 UInt8,
    n8 UInt8
)
Engine=MergeTree()
ORDER BY n1 SETTINGS index_granularity = 8192, index_granularity_bytes = '10Mi';
insert into morton_numbers (*) values(1,2,3,4,5,6,7,8);

定数の代わりにカラム名を mortonDecode の引数として使用します。

クエリ：

select untuple(mortonDecode(8, mortonEncode(n1, n2, n3, n4, n5, n6, n7, n8))) from morton_numbers;

結果：

1    2    3    4    5    6    7    8

hilbertEncode

符号なし整数のリストに対するヒルバート曲線のコードを計算します。

この関数には2つの操作モードがあります：

シンプル
拡張

シンプルモード

シンプル: 最大2つの符号なし整数を引数として受け取り、UInt64 コードを生成します。

構文

hilbertEncode(args)

パラメータ

args: 最大2つの符号なし整数または前述の型のカラム。

返される値

UInt64コード

型: UInt64

例

クエリ：

SELECT hilbertEncode(3, 4);

結果：

拡張モード

最初の引数には範囲マスク（タプル）を受け取り、その他の引数には最大2つの符号なし整数を受け取ります。

マスク内の各数は、対応する引数を左にシフトさせるビット数を設定し、範囲内で引数を効果的にスケーリングします。

構文

hilbertEncode(range_mask, args)

パラメータ

range_mask: （タプル）
args: 最大2つの符号なし整数または前述の型のカラム。

注意: args のためにカラムを使用する場合でも、提供された range_mask タプルは定数である必要があります。

返される値

UInt64コード

型: UInt64

例

クエリ：

SELECT hilbertEncode((10,6), 1024, 16);

結果：

4031541586602

注意: タプルのサイズは他の引数の数に等しくなければなりません。

例

単一の引数がタプルなしで提供されると、関数はヒルバートインデックスとしてその引数自体を返します。次元マッピングは不要です。

クエリ：

SELECT hilbertEncode(1);

結果：

例

タプルが指定された単一の引数を提供すると、関数は指定されたビット数だけ引数を左にシフトします。

クエリ：

SELECT hilbertEncode(tuple(2), 128);

結果：

例

この関数はカラムも引数として受け入れます。

クエリ：

最初にテーブルを作成してデータを挿入します。

create table hilbert_numbers(
    n1 UInt32,
    n2 UInt32
)
Engine=MergeTree()
ORDER BY n1 SETTINGS index_granularity = 8192, index_granularity_bytes = '10Mi';
insert into hilbert_numbers (*) values(1,2);

定数の代わりにカラム名を hilbertEncode の引数として使用します。

クエリ：

SELECT hilbertEncode(n1, n2) FROM hilbert_numbers;

結果：

実装の詳細

ヒルバートコードには、UInt64 が持つ情報ビット数に制限があることに注意してください。2つの引数は最大2^32（64/2）の範囲を持ち、オーバーフローはすべてゼロに制限されます。

hilbertDecode

ヒルバート曲線インデックスをデコードして、多次元空間の座標を表す符号なし整数のタプルに戻します。

hilbertEncode 関数と同様に、この関数にも2つの操作モードがあります：

シンプル
拡張

シンプルモード

最大2つの符号なし整数を引数として受け取り、UInt64コードを生成します。

構文

hilbertDecode(tuple_size, code)

パラメータ

tuple_size: 2を超えない整数値。
code: UInt64 コード。

返される値

指定されたサイズのタプル。

型: UInt64

例

クエリ：

SELECT hilbertDecode(2, 31);

結果：

["3", "4"]

拡張モード

最初の引数には範囲マスク（タプル）を受け取り、最大2つの符号なし整数を他の引数として受け取ります。マスク内の各数は、対応する引数を左にシフトさせるビット数を設定し、範囲内で引数を効果的にスケーリングします。

範囲拡張は、範囲（またはカーディナリティ）が大きく異なる引数に類似の分布が必要な場合に有益です。最大8の数に制限されています。

例

ヒルバートコードの単一の引数は常にその引数自体（タプルとして）です：

クエリ：

SELECT hilbertDecode(1, 1);

結果：

["1"]

例

タプルが指定された単一の引数は、対応するビットシフトに従って右シフトされます。

クエリ：

SELECT hilbertDecode(tuple(2), 32768);

結果：

["128"]

例

この関数は、コードのカラムを第二引数として受け取ることができます：

最初にテーブルを作成してデータを挿入します。

クエリ：

create table hilbert_numbers(
    n1 UInt32,
    n2 UInt32
)
Engine=MergeTree()
ORDER BY n1 SETTINGS index_granularity = 8192, index_granularity_bytes = '10Mi';
insert into hilbert_numbers (*) values(1,2);

定数の代わりにカラム名を hilbertDecode の引数として使用します。

クエリ：

select untuple(hilbertDecode(2, hilbertEncode(n1, n2))) from hilbert_numbers;

結果：

1    2

char​

hex​

unhex​

bin​

unbin​

bitmaskToList(num)​

bitmaskToArray(num)​

bitPositionsToArray(num)​

mortonEncode​

シンプルモード​

拡張モード​

mortonDecode​

シンプルモード​

拡張モード​

hilbertEncode​

シンプルモード​

拡張モード​

hilbertDecode​

シンプルモード​

拡張モード​

char

hex

unhex

bin

unbin

bitmaskToList(num)

bitmaskToArray(num)

bitPositionsToArray(num)

mortonEncode

シンプルモード

拡張モード

mortonDecode

シンプルモード

拡張モード

hilbertEncode

シンプルモード

拡張モード

hilbertDecode

シンプルモード

拡張モード