文字列置換用関数

注記

以下のドキュメントは system.functions システムテーブルから生成されています。

format

導入バージョン: v20.1

pattern 文字列を、引数として指定した値（文字列、整数など）でフォーマットします。Python のフォーマット機能と同様に動作します。パターン文字列には、中かっこ {} で囲まれた置換フィールドを含めることができます。中かっこ内に含まれない部分はリテラル文字列と見なされ、そのまま出力にコピーされます。リテラルの中かっこ文字は、二重の中かっこ {{ および }} でエスケープできます。フィールド名には 0 から始まる数値、または空文字列を指定できます。空文字列の場合は、暗黙的に単調増加する番号が割り当てられます。

構文

format(pattern, s0[, s1, ...])

引数

pattern — プレースホルダーを含むフォーマット文字列。String
s0[, s1, ...] — pattern に埋め込む 1 つ以上の値。Any

戻り値

フォーマット済みの文字列を返します。String

例

番号付きプレースホルダー

SELECT format('{1} {0} {1}', '世界', 'こんにちは')

┌─format('{1} {0} {1}', 'World', 'Hello')─┐
│ Hello World Hello                       │
└─────────────────────────────────────────┘

暗黙の番号付け

SELECT format('{} {}', 'こんにちは', '世界')

┌─format('{} {}', 'Hello', 'World')─┐
│ Hello World                       │
└───────────────────────────────────┘

overlay

導入バージョン: v24.9

文字列 input の一部を、インデックス offset（1 始まり）で指定される位置から、別の文字列 replace で置き換えます。

構文

overlay(s, replace, offset[, length])

引数

s — 入力文字列。String
replace — 置換に使用する文字列。const String
offset — 整数型 Int（1 始まり）。offset が負の場合は、文字列 s の末尾から数えます。Int
length — 省略可能。整数型 Int。length は、入力文字列 s のうち置換対象となる部分文字列の長さを指定します。length が指定されていない場合、s から削除されるバイト数は replace の長さと同じになります。指定されている場合は length バイトが削除されます。Int

戻り値

置換後の文字列を返します。String

例

基本的な置換

SELECT overlay('私の父はメキシコ出身です。', '母', 4) AS res;

┌─res──────────────────────┐
│ 私の母はメキシコ出身です。│
└──────────────────────────┘

長さ指定付き置換

SELECT overlay('私の父はメキシコ出身です。', '父', 4, 6) AS res;

┌─res───────────────────┐
│ 父はメキシコ出身です。│
└───────────────────────┘

overlayUTF8

導入バージョン: v24.9

文字列 s の一部を、1 始まりのインデックス offset の位置から、別の文字列 replace で置き換えます。文字列が有効な UTF-8 でエンコードされたテキストであることを前提とします。この前提が満たされない場合でも、例外はスローされず、結果は未定義です。

構文

overlayUTF8(s, replace, offset[, length])

引数

s — 入力文字列。String
replace — 置換後の文字列。const String
offset — 整数型 Int（1 始まりのインデックス）。offset が負の値の場合、入力文字列 s の末尾からのオフセットとして解釈されます。(U)Int*
length — 省略可能。入力文字列 s の中で置換対象となる部分文字列の長さを指定します。length が指定されていない場合、s から削除される文字数は replace の長さと等しくなり、指定されている場合は length 文字が削除されます。(U)Int*

戻り値

置換後の文字列を返します。String

使用例

UTF-8 の置換

SELECT overlayUTF8('私の父はオーストリア出身です。', 'トルコ', 20) AS res;

┌─res───────────────────────────┐
│ Mein Vater ist aus der Türkei.│
└───────────────────────────────┘

printf

導入バージョン: v24.8

printf 関数は、C++ の printf 関数と同様に、引数として指定された値（文字列、整数、浮動小数点数など）を使って、与えられた文字列をフォーマットします。フォーマット文字列には、% 文字で始まる書式指定子を含めることができます。 % とそれに続く書式指定子に含まれない部分はリテラルテキストとして扱われ、そのまま出力にコピーされます。リテラルの % 文字は %% でエスケープできます。

構文

printf(format[, sub1, sub2, ...])

引数

format — % 指定子を含むフォーマット文字列。String
sub1, sub2, ... — 省略可。フォーマット文字列内に埋め込む 0 個以上の値。Any

戻り値

フォーマット済みの文字列を返します。String

使用例

C++ スタイルのフォーマット

SELECT printf('%%%s %s %d', 'Hello', 'World', 2024);

┌─printf('%%%s %s %d', 'Hello', 'World', 2024)─┐
│ %Hello World 2024                            │
└──────────────────────────────────────────────┘

regexpQuoteMeta

導入バージョン: v20.1

正規表現において特別な意味を持つ次の文字の前にバックスラッシュを追加します: \0, \\, |, (, ), ^, $, ., [, ], ?, *, +, {, :, -。この実装は re2::RE2::QuoteMeta とは細部で挙動が異なります。ゼロバイト文字を \x00 ではなく \0 としてエスケープし、必要な文字だけをエスケープします。

構文

regexpQuoteMeta(s)

引数

s — 正規表現でエスケープする必要がある文字を含む入力文字列。String

戻り値

正規表現の特殊文字をエスケープした文字列を返します。String

例

正規表現の特殊文字をエスケープする

SELECT regexpQuoteMeta('Hello. [World]? (Yes)*') AS res

┌─res───────────────────────────┐
│ Hello\. \[World\]\? \(Yes\)\* │
└───────────────────────────────┘

replaceAll

導入バージョン: v1.1

haystack 内にある部分文字列 pattern のすべての出現を、文字列 replacement で置換します。

構文

replaceAll(haystack, pattern, replacement)

別名: replace

引数

haystack — 検索対象の入力文字列。String
pattern — 検索して置換する部分文字列。const String
replacement — pattern を置き換える文字列。const String

返される値

pattern のすべての出現箇所を置換した文字列を返します。String

例

すべての出現箇所を置換

SELECT replaceAll('Hello, Hello world', 'Hello', 'Hi') AS res;

┌─res──────────┐
│ Hi, Hi world │
└──────────────┘

replaceOne

導入バージョン: v1.1

haystack 内で pattern が最初に出現する箇所を、文字列 replacement に置き換えます。

構文

replaceOne(haystack, pattern, replacement)

引数

haystack — 検索対象となる入力文字列。String
pattern — 検索および置換の対象となる部分文字列。const String
replacement — pattern を置き換える文字列。const String

返却値

pattern の最初の出現箇所を置換した文字列を返します。String

例

最初の出現箇所を置換

SELECT replaceOne('Hello, Hello world', 'Hello', 'Hi') AS res;

┌─res─────────────┐
│ やあ、Hello world │
└─────────────────┘

replaceRegexpAll

導入: v1.1

replaceRegexpOne と同様ですが、パターンに一致するすべての出現箇所を置換します。例外として、正規表現が空の部分文字列にマッチした場合、その置換は 1 回しか行われません。

構文

replaceRegexpAll(haystack, pattern, replacement)

別名: REGEXP_REPLACE

引数

haystack — 検索対象の入力文字列。String
pattern — 検索する正規表現パターン。const String
replacement — パターンを置き換える文字列。後方参照などの置換パターンを含めることができる。const String

戻り値

正規表現にマッチした部分がすべて置き換えられた文字列を返します。String

例

すべての文字を2回繰り返した文字で置き換える

SELECT replaceRegexpAll('Hello123', '.', '\\\\0\\\\0') AS res

┌─res──────────────────┐
│ HHeelllloo112233     │
└──────────────────────┘

空文字列の置換例

SELECT replaceRegexpAll('Hello, World!', '^', 'here: ') AS res

┌─res─────────────────┐
│ here: こんにちは、世界！ │
└─────────────────────┘

replaceRegexpOne

導入バージョン: v1.1

haystack 内で、正規表現パターン pattern（re2 構文）にマッチする部分文字列の最初の出現箇所を、文字列 replacement で置換します。 replacement には、\0-\9 の置換指定を含めることができます。置換指定 \1-\9 は第1〜第9のキャプチャグループ（サブマッチ）に対応し、置換指定 \0 はマッチ全体に対応します。 pattern または replacement の文字列内でリテラルな \ 文字を使用するには、\ を使ってエスケープしてください。また、文字列リテラルでは追加のエスケープが必要になる点にも注意してください。

構文

replaceRegexpOne(haystack, pattern, replacement)

引数

haystack — 検索対象となる入力文字列。String
pattern — 検索する正規表現パターン。const String
replacement — パターンを置き換える文字列。後方参照などの置換式を含めることができる。const String

返される値

最初にマッチした部分が置換された文字列を返します。String

例

ISO 日付をアメリカ式の日付形式に変換する

SELECT DISTINCT
    EventDate,
    replaceRegexpOne(toString(EventDate), '(\\d{4})-(\\d{2})-(\\d{2})', '\\2/\\3/\\1') AS res
FROM test.hits
LIMIT 7
FORMAT TabSeparated

2014-03-17      03/17/2014
2014-03-18      03/18/2014
2014-03-19      03/19/2014
2014-03-20      03/20/2014
2014-03-21      03/21/2014
2014-03-22      03/22/2014
2014-03-23      03/23/2014

文字列を10回コピーする

SELECT replaceRegexpOne('Hello, World!', '.*', '\\\\0\\\\0\\\\0\\\\0\\\\0\\\\0\\\\0\\\\0\\\\0\\\\0') AS res

┌─res────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！こんにちは、世界！ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

translate

導入バージョン: v22.7

文字列 s 内の文字を、from と to 文字列で定義された 1 対 1 の文字マッピングを使って置換します。 from と to は定数の ASCII 文字列である必要があります。 from と to の長さが同じ場合、s 内に現れる from の 1 文字目はすべて to の 1 文字目に、from の 2 文字目はすべて to の 2 文字目に、というように順に置換されます。 from に含まれる文字数が to より多い場合、from の末尾側で to に対応する文字を持たないすべての文字は、s から削除されます。 s 内の非 ASCII 文字は、この関数によって変更されません。

構文

translate(s, from, to)

引数

s — 変換対象の入力文字列。String
from — 置換対象の文字を含む定数 ASCII 文字列。const String
to — 置換後の文字を含む定数 ASCII 文字列。const String

戻り値

文字の変換が適用された文字列を返します。String

例

文字の対応付け

SELECT translate('Hello, World!', 'delor', 'DELOR') AS res

┌─res───────────┐
│ HELLO, WORLD! │
└───────────────┘

長さの違い

SELECT translate('clickhouse', 'clickhouse', 'CLICK') AS res

┌─res───┐
│ クリック │
└───────┘

translateUTF8

導入バージョン: v22.7

translate と同様ですが、s、from、to の各引数が UTF-8 エンコードされた文字列であると仮定します。

構文

translateUTF8(s, from, to)

引数

s — 変換対象の UTF-8 入力文字列。String
from — 置換対象の文字を含む定数 UTF-8 文字列。const String
to — 置換後の文字を含む定数 UTF-8 文字列。const String

返される値

String 型の値を返します。String

例

UTF-8 文字の変換

SELECT translateUTF8('Münchener Straße', 'üß', 'us') AS res;

┌─res──────────────┐
│ Munchener Strase │
└──────────────────┘

format​

overlay​

overlayUTF8​

printf​

regexpQuoteMeta​

replaceAll​

replaceOne​

replaceRegexpAll​

replaceRegexpOne​

translate​

translateUTF8​

format

overlay

overlayUTF8

printf

regexpQuoteMeta

replaceAll

replaceOne

replaceRegexpAll

replaceRegexpOne

translate

translateUTF8