generateUUIDv4
バージョン4 UUIDを生成します。
構文
引数
expr — クエリ内で関数が複数回呼び出される場合に、共通部分式排除を回避するために使用される任意の式。式の値は返されるUUIDには影響しません。オプション。
返される値
UUIDv4型の値。
例
まずUUID型のカラムを持つテーブルを作成し、その後生成したUUIDv4をテーブルに挿入します。
CREATE TABLE tab (uuid UUID) ENGINE = Memory;
INSERT INTO tab SELECT generateUUIDv4();
SELECT * FROM tab;
結果:
┌─────────────────────────────────uuid─┐
│ f4bf890f-f9dc-4332-ad5c-0c18e73f28e9 │
└──────────────────────────────────────┘
行ごとに複数のUUIDを生成した例
SELECT generateUUIDv4(1), generateUUIDv4(2);
┌─generateUUIDv4(1)────────────────────┬─generateUUIDv4(2)────────────────────┐
│ 2d49dc6e-ddce-4cd0-afb8-790956df54c1 │ 8abf8c13-7dea-4fdf-af3e-0e18767770e6 │
└──────────────────────────────────────┴──────────────────────────────────────┘
generateUUIDv7
バージョン7 UUIDを生成します。
生成されたUUIDには、ミリ秒単位の現在のUnixタイムスタンプ（48ビット）、バージョン「7」（4ビット）、ミリ秒内のUUIDを区別するためのカウンタ（42ビット）（バリアントフィールド「2」、2ビットを含む）、およびランダムフィールド（32ビット）が含まれます。
特定のタイムスタンプ（unix_ts_ms）に対して、カウンタはランダムな値から始まり、タイムスタンプが変わるまで新しいUUIDごとに1ずつ増加します。
カウンタがオーバーフローした場合、タイムスタンプフィールドは1ずつ増加し、カウンタはランダムな新しい開始値にリセットされます。
関数generateUUIDv7は、同時に実行されているスレッドとクエリのすべての関数呼び出しにおいて、タイムスタンプ内のカウンタフィールドが単調に増加することを保証します。
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
├─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
| unix_ts_ms |
├─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
| unix_ts_ms | ver | counter_high_bits |
├─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
|var| counter_low_bits |
├─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
| rand_b |
└─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┘
注記
2024年4月現在、バージョン7のUUIDは草案ステータスであり、そのレイアウトは将来的に変更される可能性があります。
構文
引数
expr — クエリ内で関数が複数回呼び出される場合に、共通部分式排除を回避するために使用される任意の式。式の値は返されるUUIDには影響しません。オプション。
返される値
UUIDv7型の値。
例
まずUUID型のカラムを持つテーブルを作成し、その後生成したUUIDv7をテーブルに挿入します。
CREATE TABLE tab (uuid UUID) ENGINE = Memory;
INSERT INTO tab SELECT generateUUIDv7();
SELECT * FROM tab;
結果:
┌─────────────────────────────────uuid─┐
│ 018f05af-f4a8-778f-beee-1bedbc95c93b │
└──────────────────────────────────────┘
行ごとに複数のUUIDを生成した例
SELECT generateUUIDv7(1), generateUUIDv7(2);
┌─generateUUIDv7(1)────────────────────┬─generateUUIDv7(2)────────────────────┐
│ 018f05c9-4ab8-7b86-b64e-c9f03fbd45d1 │ 018f05c9-4ab8-7b86-b64e-c9f12efb7e16 │
└──────────────────────────────────────┴──────────────────────────────────────┘
empty
入力UUIDが空であるかどうかをチェックします。
構文
UUIDは、すべてのゼロ（ゼロUUID）を含む場合、空であると見なされます。
この関数は、配列や文字列にも適用されます。
引数
返される値
- 空のUUIDの場合は
1、非空のUUIDの場合は0を返します。 UInt8。
例
UUID値を生成するには、ClickHouseが提供するgenerateUUIDv4関数を使用します。
クエリ：
SELECT empty(generateUUIDv4());
結果：
┌─empty(generateUUIDv4())─┐
│ 0 │
└─────────────────────────┘
notEmpty
入力UUIDが非空であるかどうかをチェックします。
構文
UUIDは、すべてのゼロ（ゼロUUID）を含む場合、空であると見なされます。
この関数は、配列や文字列にも適用されます。
引数
返される値
- 非空のUUIDの場合は
1、空のUUIDの場合は0を返します。 UInt8。
例
UUID値を生成するには、ClickHouseが提供するgenerateUUIDv4関数を使用します。
クエリ：
SELECT notEmpty(generateUUIDv4());
結果：
┌─notEmpty(generateUUIDv4())─┐
│ 1 │
└────────────────────────────┘
toUUID
String型の値をUUIDに変換します。
返される値
UUID型の値。
使用例
SELECT toUUID('61f0c404-5cb3-11e7-907b-a6006ad3dba0') AS uuid
結果：
┌─────────────────────────────────uuid─┐
│ 61f0c404-5cb3-11e7-907b-a6006ad3dba0 │
└──────────────────────────────────────┘
toUUIDOrDefault
引数
string — 36文字の文字列またはFixedString(36)。 String。default — 最初の引数をUUID型に変換できない場合のデフォルトとして使用されるUUID。 UUID。
返される値
UUID
toUUIDOrDefault(string, default)
返される値
UUID型の値。
使用例
この最初の例は、最初の引数をUUID型に変換可能なため、UUID型に変換された値を返します。
SELECT toUUIDOrDefault('61f0c404-5cb3-11e7-907b-a6006ad3dba0', cast('59f0c404-5cb3-11e7-907b-a6006ad3dba0' as UUID));
結果：
┌─toUUIDOrDefault('61f0c404-5cb3-11e7-907b-a6006ad3dba0', CAST('59f0c404-5cb3-11e7-907b-a6006ad3dba0', 'UUID'))─┐
│ 61f0c404-5cb3-11e7-907b-a6006ad3dba0 │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
この2番目の例は、1番目の引数をUUID型に変換できないため、2番目の引数（提供されたデフォルトUUID）を返します。
SELECT toUUIDOrDefault('-----61f0c404-5cb3-11e7-907b-a6006ad3dba0', cast('59f0c404-5cb3-11e7-907b-a6006ad3dba0' as UUID));
結果：
┌─toUUIDOrDefault('-----61f0c404-5cb3-11e7-907b-a6006ad3dba0', CAST('59f0c404-5cb3-11e7-907b-a6006ad3dba0', 'UUID'))─┐
│ 59f0c404-5cb3-11e7-907b-a6006ad3dba0 │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
toUUIDOrNull
String型の引数を受け取り、UUIDに解析しようとします。失敗した場合はNULLを返します。
返される値
Nullable(UUID)型の値。
使用例
SELECT toUUIDOrNull('61f0c404-5cb3-11e7-907b-a6006ad3dba0T') AS uuid
結果：
┌─uuid─┐
│ ᴺᵁᴸᴸ │
└──────┘
toUUIDOrZero
String型の引数を受け取り、UUIDに解析しようとします。失敗した場合はゼロUUIDを返します。
返される値
UUID型の値。
使用例
SELECT toUUIDOrZero('61f0c404-5cb3-11e7-907b-a6006ad3dba0T') AS uuid
結果：
┌─────────────────────────────────uuid─┐
│ 00000000-0000-0000-0000-000000000000 │
└──────────────────────────────────────┘
UUIDStringToNum
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx形式の36文字を含むstringを受け取り、そのバイナリ表現をFixedString(16)として返します。形式は、variant（デフォルトはビッグエンディアン）によってオプションで指定できます。
構文
UUIDStringToNum(string[, variant = 1])
引数
返される値
FixedString(16)
使用例
SELECT
'612f3c40-5d3b-217e-707b-6a546a3d7b29' AS uuid,
UUIDStringToNum(uuid) AS bytes
結果：
┌─uuid─────────────────────────────────┬─bytes────────────┐
│ 612f3c40-5d3b-217e-707b-6a546a3d7b29 │ a/<@];!~p{jTj={) │
└──────────────────────────────────────┴──────────────────┘
SELECT
'612f3c40-5d3b-217e-707b-6a546a3d7b29' AS uuid,
UUIDStringToNum(uuid, 2) AS bytes
結果：
┌─uuid─────────────────────────────────┬─bytes────────────┐
│ 612f3c40-5d3b-217e-707b-6a546a3d7b29 │ @</a;]~!p{jTj={) │
└──────────────────────────────────────┴──────────────────┘
UUIDNumToString
UUIDのバイナリ表現を含むbinaryを受け取り、形式はオプションでvariant（デフォルトはビッグエンディアン）によって指定され、文字列を返します。文字列は36文字のテキスト形式です。
構文
UUIDNumToString(binary[, variant = 1])
引数
binary — UUIDのバイナリ表現としてのFixedString(16)。variant — RFC4122で指定されたバリアントを表す整数。 1 = ビッグエンディアン（デフォルト）、2 = Microsoft。
返される値
文字列。
使用例
SELECT
'a/<@];!~p{jTj={)' AS bytes,
UUIDNumToString(toFixedString(bytes, 16)) AS uuid
結果：
┌─bytes────────────┬─uuid─────────────────────────────────┐
│ a/<@];!~p{jTj={) │ 612f3c40-5d3b-217e-707b-6a546a3d7b29 │
└──────────────────┴──────────────────────────────────────┘
SELECT
'@</a;]~!p{jTj={)' AS bytes,
UUIDNumToString(toFixedString(bytes, 16), 2) AS uuid
結果：
┌─bytes────────────┬─uuid─────────────────────────────────┐
│ @</a;]~!p{jTj={) │ 612f3c40-5d3b-217e-707b-6a546a3d7b29 │
└──────────────────┴──────────────────────────────────────┘
UUIDToNum
UUIDを受け取り、そのバイナリ表現をFixedString(16)として返します。形式はオプションでvariant（デフォルトはビッグエンディアン）によって指定できます。この関数は、UUIDStringToNum(toString(uuid))の二つの別々の関数への呼び出しを置き換えるもので、UUIDから文字列への中間変換を必要とせずにUUIDからバイトを抽出できます。
構文
UUIDToNum(uuid[, variant = 1])
引数
uuid — UUID。variant — RFC4122で指定されたバリアントを表す整数。 1 = ビッグエンディアン（デフォルト）、2 = Microsoft。
返される値
UUIDのバイナリ表現。
使用例
SELECT
toUUID('612f3c40-5d3b-217e-707b-6a546a3d7b29') AS uuid,
UUIDToNum(uuid) AS bytes
結果：
┌─uuid─────────────────────────────────┬─bytes────────────┐
│ 612f3c40-5d3b-217e-707b-6a546a3d7b29 │ a/<@];!~p{jTj={) │
└──────────────────────────────────────┴──────────────────┘
SELECT
toUUID('612f3c40-5d3b-217e-707b-6a546a3d7b29') AS uuid,
UUIDToNum(uuid, 2) AS bytes
結果：
┌─uuid─────────────────────────────────┬─bytes────────────┐
│ 612f3c40-5d3b-217e-707b-6a546a3d7b29 │ @</a;]~!p{jTj={) │
└──────────────────────────────────────┴──────────────────┘
UUIDv7ToDateTime
UUIDバージョン7のタイムスタンプコンポーネントを返します。
構文
UUIDv7ToDateTime(uuid[, timezone])
引数
返される値
- ミリ秒精度のタイムスタンプ。UUIDが有効なバージョン7 UUIDでない場合は、1970-01-01 00:00:00.000を返します。 DateTime64(3)。
使用例
SELECT UUIDv7ToDateTime(toUUID('018f05c9-4ab8-7b86-b64e-c9f03fbd45d1'))
結果：
┌─UUIDv7ToDateTime(toUUID('018f05c9-4ab8-7b86-b64e-c9f03fbd45d1'))─┐
│ 2024-04-22 15:30:29.048 │
└──────────────────────────────────────────────────────────────────┘
SELECT UUIDv7ToDateTime(toUUID('018f05c9-4ab8-7b86-b64e-c9f03fbd45d1'), 'America/New_York')
結果：
┌─UUIDv7ToDateTime(toUUID('018f05c9-4ab8-7b86-b64e-c9f03fbd45d1'), 'America/New_York')─┐
│ 2024-04-22 08:30:29.048 │
└──────────────────────────────────────────────────────────────────────────────────────┘
serverUUID
ClickHouseサーバーの最初の起動時に生成されたランダムUUIDを返します。このUUIDはClickHouseサーバーディレクトリ（例： /var/lib/clickhouse/）内のuuidファイルに保存され、サーバーの再起動間で保持されます。
構文
返される値
generateSnowflakeID
Snowflake IDを生成します。
生成されたSnowflake IDには、ミリ秒単位の現在のUnixタイムスタンプ（41 + 1のトップゼロビット）、機械ID（10ビット）、およびミリ秒内のIDを区別するためのカウンタ（12ビット）が含まれます。
特定のタイムスタンプ（unix_ts_ms）に対して、カウンタは0から始まり、タイムスタンプが変わるまで新しいSnowflake IDごとに1ずつ増加します。
カウンタがオーバーフローした場合、タイムスタンプフィールドは1ずつ増加し、カウンタは0にリセットされます。
関数generateSnowflakeIDは、タイムスタンプ内のカウンタフィールドが単調に増加することをすべての関数呼び出しにおいて保証します。
注記
生成されたSnowflake IDはUNIXエポック1970-01-01に基づいています。
Snowflake IDのエポックに関する標準や推奨は存在しませんが、他のシステムでの実装では異なるエポック（例：Twitter/X（2010-11-04）やMastodon（2015-01-01））を使用している場合があります。
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
├─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
|0| timestamp |
├─┼ ┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┼─┤
| | machine_id | machine_seq_num |
└─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┘
構文
generateSnowflakeID([expr, [machine_id]])
引数
expr — クエリ内で関数が複数回呼び出される場合に、共通部分式排除を回避するために使用される任意の式。式の値は返されるSnowflake IDには影響しません。オプション。machine_id — マシンID、最下位10ビットが使用されます。 Int64。オプション。
返される値
UInt64型の値。
例
まずUInt64型のカラムを持つテーブルを作成し、その後生成したSnowflake IDをテーブルに挿入します。
CREATE TABLE tab (id UInt64) ENGINE = Memory;
INSERT INTO tab SELECT generateSnowflakeID();
SELECT * FROM tab;
結果：
┌──────────────────id─┐
│ 7199081390080409600 │
└─────────────────────┘
行ごとに複数のSnowflake IDを生成した例
SELECT generateSnowflakeID(1), generateSnowflakeID(2);
┌─generateSnowflakeID(1)─┬─generateSnowflakeID(2)─┐
│ 7199081609652224000 │ 7199081609652224001 │
└────────────────────────┴────────────────────────┘
式とマシンIDを使用した例
SELECT generateSnowflakeID('expr', 1);
┌─generateSnowflakeID('expr', 1)─┐
│ 7201148511606784002 │
└────────────────────────────────┘
snowflakeToDateTime
Snowflake IDのタイムスタンプコンポーネントをDateTime形式で抽出します。
構文
snowflakeToDateTime(value[, time_zone])
引数
value — Snowflake ID。 Int64。time_zone — タイムゾーン。この関数は、time_stringをタイムゾーンに従って解析します。オプション。 String。
返される値
例
クエリ：
SELECT snowflakeToDateTime(CAST('1426860702823350272', 'Int64'), 'UTC');
結果：
┌─snowflakeToDateTime(CAST('1426860702823350272', 'Int64'), 'UTC')─┐
│ 2021-08-15 10:57:56 │
└──────────────────────────────────────────────────────────────────┘
snowflakeToDateTime64
Snowflake IDのタイムスタンプコンポーネントをDateTime64形式で抽出します。
構文
snowflakeToDateTime64(value[, time_zone])
引数
value — Snowflake ID。 Int64。time_zone — タイムゾーン。この関数は、time_stringをタイムゾーンに従って解析します。オプション。 String。
返される値
valueのタイムスタンプコンポーネントをスケール=3のDateTime64として返します。すなわち、ミリ秒精度です。
例
クエリ：
SELECT snowflakeToDateTime64(CAST('1426860802823350272', 'Int64'), 'UTC');
結果：
┌─snowflakeToDateTime64(CAST('1426860802823350272', 'Int64'), 'UTC')─┐
│ 2021-08-15 10:58:19.841 │
└────────────────────────────────────────────────────────────────────┘
dateTimeToSnowflake
DateTime値を指定された時刻の最初のSnowflake IDに変換します。
構文
dateTimeToSnowflake(value)
引数
返される値
- 入力値をInt64データ型に変換した値として、その時刻の最初のSnowflake IDを返します。
例
クエリ：
WITH toDateTime('2021-08-15 18:57:56', 'Asia/Shanghai') AS dt SELECT dateTimeToSnowflake(dt);
結果：
┌─dateTimeToSnowflake(dt)─┐
│ 1426860702823350272 │
└─────────────────────────┘
dateTime64ToSnowflake
DateTime64を指定された時刻の最初のSnowflake IDに変換します。
構文
dateTime64ToSnowflake(value)
引数
返される値
- 入力値をInt64データ型に変換した値として、その時刻の最初のSnowflake IDを返します。
例
クエリ：
WITH toDateTime64('2021-08-15 18:57:56.492', 3, 'Asia/Shanghai') AS dt64 SELECT dateTime64ToSnowflake(dt64);
結果：
┌──────────────────────dt─┬─────────────────res─┐
│ 2021-08-15 18:57:56.493 │ 6832626394434895872 │
└─────────────────────────┴─────────────────────┘
snowflakeIDToDateTime
Snowflake IDのタイムスタンプコンポーネントをDateTime型の値として返します。
構文
snowflakeIDToDateTime(value[, epoch[, time_zone]])
引数
value — Snowflake ID。 UInt64。epoch - Snowflake IDのエポック（1970-01-01からのミリ秒）。デフォルトは0（1970-01-01）。Twitter/Xのエポック（2015-01-01）の場合は1288834974657を指定します。オプション。 UInt*。time_zone — タイムゾーン。この関数は、time_stringをタイムゾーンに従って解析します。オプション。 String。
返される値
例
クエリ：
SELECT snowflakeIDToDateTime(7204436857747984384) AS res
結果：
┌─────────────────res─┐
│ 2024-06-06 10:59:58 │
└─────────────────────┘
snowflakeIDToDateTime64
Snowflake IDのタイムスタンプコンポーネントをDateTime64型の値として返します。
構文
snowflakeIDToDateTime64(value[, epoch[, time_zone]])
引数
value — Snowflake ID。 UInt64。epoch - Snowflake IDのエポック（1970-01-01からのミリ秒）。デフォルトは0（1970-01-01）。Twitter/Xのエポック（2015-01-01）の場合は1288834974657を指定します。オプション。 UInt*。time_zone — タイムゾーン。この関数は、time_stringをタイムゾーンに従って解析します。オプション。 String。
返される値
valueのタイムスタンプコンポーネントをスケール=3のDateTime64として返します。すなわち、ミリ秒精度です。
例
クエリ：
SELECT snowflakeIDToDateTime64(7204436857747984384) AS res
結果：
┌─────────────────res─┐
│ 2024-06-06 10:59:58 │
└─────────────────────┘
dateTimeToSnowflakeID
DateTime値を指定された時刻の最初のSnowflake IDに変換します。
構文
dateTimeToSnowflakeID(value[, epoch])
引数
value — 日付と時刻。 DateTime。epoch - Snowflake IDのエポック（1970-01-01からのミリ秒）。デフォルトは0（1970-01-01）。Twitter/Xのエポック（2015-01-01）の場合は1288834974657を指定します。オプション。 UInt*。
返される値
- 入力値をUInt64として変換した値。その時刻の最初のSnowflake IDを返します。
例
クエリ：
SELECT toDateTime('2021-08-15 18:57:56', 'Asia/Shanghai') AS dt, dateTimeToSnowflakeID(dt) AS res;
結果：
┌──────────────────dt─┬─────────────────res─┐
│ 2021-08-15 18:57:56 │ 6832626392367104000 │
└─────────────────────┴─────────────────────┘
dateTime64ToSnowflakeID
DateTime64を指定された時刻の最初のSnowflake IDに変換します。
構文
dateTime64ToSnowflakeID(value[, epoch])
引数
value — 日付と時刻。 DateTime64。epoch - Snowflake IDのエポック（1970-01-01からのミリ秒）。デフォルトは0（1970-01-01）。Twitter/Xのエポック（2015-01-01）の場合は1288834974657を指定します。オプション。 UInt*。
返される値
- 入力値をUInt64として変換した値。その時刻の最初のSnowflake IDを返します。
例
クエリ：
SELECT toDateTime('2021-08-15 18:57:56.493', 3, 'Asia/Shanghai') AS dt, dateTime64ToSnowflakeID(dt) AS res;
結果：
┌──────────────────────dt─┬─────────────────res─┐
│ 2021-08-15 18:57:56.493 │ 6832626394434895872 │
└─────────────────────────┴─────────────────────┘
