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

UUIDsを扱う関数

generateUUIDv4

バージョン4UUIDを生成します。

構文

引数

  • expr — クエリ内で関数が複数回呼ばれた場合に共通部分式の排除を回避するために使用される任意の。この式の値は返されるUUIDに影響を与えません。省略可能。

返される値

UUIDv4型の値。

まず、UUID型のカラムを持つテーブルを作成し、次に生成されたUUIDv4をテーブルに挿入します。

結果:

行ごとに複数のUUIDが生成される例

generateUUIDv7

バージョン7UUIDを生成します。

生成されたUUIDは、現在のUnixタイムスタンプをミリ秒(48ビット)で含み、次にバージョン「7」(4ビット)、ミリ秒内のUUIDを区別するためのカウンタ(42ビット)(バリアントフィールド「2」を含む、2ビット)およびランダムフィールド(32ビット)が続きます。 任意の理想的なタイムスタンプ(unix_ts_ms)について、カウンタはランダムな値から始まり、新しいUUIDごとに1ずつ増加します。タイムスタンプが変更されるまで。 カウンタがオーバーフローした場合、タイムスタンプフィールドが1増加し、カウンタはランダムな新しい開始値にリセットされます。

関数generateUUIDv7は、タイムスタンプ内のカウンタフィールドがすべての関数呼び出しで単調増加することを保証します。

注記

2024年4月現在、バージョン7のUUIDはドラフト状態であり、将来的にレイアウトが変更される可能성이あることに注意してください。

構文

引数

  • expr — クエリ内で関数が複数回呼ばれた場合に共通部分式の排除を回避するために使用される任意の。この式の値は返されるUUIDに影響を与えません。省略可能。

返される値

UUIDv7型の値。

まず、UUID型のカラムを持つテーブルを作成し、次に生成されたUUIDv7をテーブルに挿入します。

結果:

行ごとに複数のUUIDが生成される例

empty

入力UUIDが空かどうかを確認します。

構文

UUIDがすべてゼロ(ゼロUUID)を含む場合、それは空と見なされます。

この関数は、配列文字列にも機能します。

引数

  • x — UUID。UUID

返される値

  • 空のUUIDには1を、空でないUUIDには0を返します。UInt8

UUID値を生成するために、ClickHouseはgenerateUUIDv4関数を提供します。

クエリ:

結果:

notEmpty

入力UUIDが空でないかどうかを確認します。

構文

UUIDがすべてゼロ(ゼロUUID)を含む場合、それは空と見なされます。

この関数は、配列文字列にも機能します。

引数

  • x — UUID。UUID

返される値

  • 空でないUUIDには1を、空のUUIDには0を返します。UInt8

UUID値を生成するために、ClickHouseはgenerateUUIDv4関数を提供します。

クエリ:

結果:

toUUID

String型の値をUUIDに変換します。

返される値

UUID型の値。

使用例

結果:

toUUIDOrDefault

引数

  • string — 36文字の文字列またはFixedString(36)。String
  • default — 最初の引数がUUID型に変換できない場合にデフォルトとして使用されるUUID。UUID

返される値

UUID

返される値

UUID型の値。

使用例

この最初の例では、変換できる最初の引数をUUID型に変換します。

結果:

この第2の例では、最初の引数がUUID型に変換できないため、提供されたデフォルトUUID(第2引数)が返されます。

結果:

toUUIDOrNull

String型の引数を受け取り、UUIDにパースを試みます。失敗した場合はNULLを返します。

返される値

Nullable(UUID)型の値。

使用例

結果:

toUUIDOrZero

String型の引数を受け取り、UUIDにパースを試みます。失敗した場合はゼロUUIDを返します。

返される値

UUID型の値。

使用例

結果:

UUIDStringToNum

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx形式の36文字を含むstringを受け取り、そのバイナリ表現としてFixedString(16)を返します。形式はvariant(デフォルトはBig-endian)でオプション指定できます。

構文

引数

  • string — 36文字の文字列またはFixedString
  • variantRFC4122で指定されたバリアントを表す整数。1 = Big-endian(デフォルト)、2 = Microsoft

返される値

FixedString(16)

使用例

結果:

結果:

UUIDNumToString

UUIDのバイナリ表現としてのbinaryを含み、指定されたvariant(デフォルトはBig-endian)によってオプションでその形式を指定し、テキスト形式の36文字を含む文字列を返します。

構文

引数

  • binary — UUIDのバイナリ表現としてのFixedString(16)
  • variantRFC4122で指定されたバリアントを表す整数。1 = Big-endian(デフォルト)、2 = Microsoft

返される値

文字列。

使用例

結果:

結果:

UUIDToNum

UUIDを受け取り、そのバイナリ表現をFixedString(16)として返します。形式はオプションでvariant(デフォルトはBig-endian)によって指定できます。この関数は、UUIDからUUIDを抽出するためにUUIDStringToNum(toString(uuid))を2つの異なる関数を呼び出す必要がなくします。

構文

引数

  • uuidUUID
  • variantRFC4122で指定されたバリアントを表す整数。1 = Big-endian(デフォルト)、2 = Microsoft

返される値

UUIDのバイナリ表現。

使用例

結果:

結果:

UUIDv7ToDateTime

UUIDバージョン7のタイムスタンプコンポーネントを返します。

構文

引数

返される値

  • ミリ秒精度のタイムスタンプ。UUIDが無効なバージョン7 UUIDの場合は1970-01-01 00:00:00.000を返します。DateTime64(3)

使用例

結果:

結果:

serverUUID

ClickHouseサーバーの最初の起動時に生成されたランダムなUUIDを返します。UUIDはClickHouseサーバーディレクトリ(例:/var/lib/clickhouse/)内のファイルuuidに保存され、サーバーの再起動の間も保持されます。

構文

返される値

  • サーバーのUUID。UUID

generateSnowflakeID

Snowflake IDを生成します。

生成されたSnowflake IDは、現在のUnixタイムスタンプをミリ秒(41 + 1の上位ゼロビット)で含み、次にマシンID(10ビット)およびカウンタ(12ビット)が続き、ミリ秒内でIDを区別します。 任意の理想的なタイムスタンプ(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))を使用することがあります。

構文

引数

  • expr — クエリ内で関数が複数回呼ばれた場合に共通部分式の排除を回避するために使用される任意の。この式の値は返されるSnowflake IDに影響を与えません。省略可能。
  • machine_id — マシンIDで、最下位10ビットが使用されます。Int64。省略可能。

返される値

UInt64型の値。

まず、UInt64型のカラムを持つテーブルを作成し、次に生成されたSnowflake IDをテーブルに挿入します。

結果:

行ごとに複数のSnowflake IDが生成される例

式とマシンIDを使用する例

snowflakeToDateTime

Deprecated feature
危険

この関数は非推奨であり、設定allow_deprecated_snowflake_conversion_functionsが有効である場合にのみ使用できます。 将来的にこの関数は削除される予定です。

Snowflake IDのタイムスタンプコンポーネントをDateTime形式で抽出します。

構文

引数

  • value — Snowflake ID。Int64
  • time_zoneタイムゾーン。関数はタイムゾーンに従ってtime_stringを解析します。省略可能。String

返される値

  • valueのタイムスタンプコンポーネントをDateTime値として返します。

クエリ:

結果:

snowflakeToDateTime64

Deprecated feature
危険

この関数は非推奨であり、設定allow_deprecated_snowflake_conversion_functionsが有効である場合にのみ使用できます。 将来的にこの関数は削除される予定です。

Snowflake IDのタイムスタンプコンポーネントをDateTime64形式で抽出します。

構文

引数

  • value — Snowflake ID。Int64
  • time_zoneタイムゾーン。関数はタイムゾーンに従ってtime_stringを解析します。省略可能。String

返される値

  • valueのタイムスタンプコンポーネントを、スケール=3のDateTime64として返します。すなわち、ミリ秒精度です。

クエリ:

結果:

dateTimeToSnowflake

Deprecated feature
危険

この関数は非推奨であり、設定allow_deprecated_snowflake_conversion_functionsが有効である場合にのみ使用できます。 将来的にこの関数は削除される予定です。

DateTime値を指定された時刻の最初のSnowflake IDに変換します。

構文

引数

  • value — 時間を含む日付。DateTime

返される値

  • 入力値をその時が最初のSnowflake IDとしてUInt64データ型に変換します。

クエリ:

結果:

dateTime64ToSnowflake

Deprecated feature
危険

この関数は非推奨であり、設定allow_deprecated_snowflake_conversion_functionsが有効である場合にのみ使用できます。 将来的にこの関数は削除される予定です。

DateTime64を指定された時刻の最初のSnowflake IDに変換します。

構文

引数

返される値

  • 入力値をその時の最初のSnowflake IDとしてUInt64データ型に変換します。

クエリ:

結果:

snowflakeIDToDateTime

Snowflake IDのタイムスタンプコンポーネントをDateTime型の値として返します。

構文

引数

  • 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のタイムスタンプコンポーネントをDateTime値として返します。

クエリ:

結果:

snowflakeIDToDateTime64

Snowflake IDのタイムスタンプコンポーネントをDateTime64型の値として返します。

構文

引数

  • 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として返します。すなわち、ミリ秒精度です。

クエリ:

結果:

dateTimeToSnowflakeID

DateTime値を指定された時刻の最初のSnowflake IDに変換します。

構文

引数

  • value — 時間を含む日付。DateTime
  • epoch - Snowflake IDのエポック(1970-01-01からのミリ秒)。デフォルトは0(1970-01-01)。Twitter/Xエポック(2015-01-01)の場合、1288834974657を指定します。省略可能。UInt*

返される値

  • 入力値をその時の最初のSnowflake IDとしてUInt64に変換します。

クエリ:

結果:

dateTime64ToSnowflakeID

DateTime64を指定された時刻の最初のSnowflake IDに変換します。

構文

引数

  • value — 時間を含む日付。DateTime64
  • epoch - Snowflake IDのエポック(1970-01-01からのミリ秒)。デフォルトは0(1970-01-01)。Twitter/Xエポック(2015-01-01)の場合、1288834974657を指定します。省略可能。UInt*

返される値

  • 入力値をその時の最初のSnowflake IDとしてUInt64に変換します。

クエリ:

結果:

参照