字符串替换函数

注意

以下文档内容是基于 system.functions 系统表自动生成的。

format

引入版本：v20.1.0

使用参数中给出的值（字符串、整数等）对 pattern 字符串进行格式化，类似于 Python 中的字符串格式化。 pattern 字符串可以包含由花括号 {} 包围的替换字段。任何不在花括号中的内容都被视为字面文本，并原样复制到输出中。字面量花括号字符可以通过成对花括号进行转义：{{ 和 }}。字段名可以是数字（从 0 开始）或为空（为空时会隐式按递增的数字进行编号）。

语法

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

参数

pattern — 包含占位符的格式字符串。String
s0[, s1, ...] — 一个或多个要插入到 pattern 中的值。Any

返回值

返回格式化后的字符串。String

示例

带编号的占位符

SELECT format('{1} {0} {1}', 'World', 'Hello')

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

隐式编号

SELECT format('{} {}', 'Hello', 'World')

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

overlay

自 v24.9.0 引入

从以 1 为起始的索引位置 offset 开始，将字符串 input 的一部分替换为另一个字符串 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('My father is from Mexico.', 'mother', 4) AS res;

┌─res──────────────────────┐
│ My mother is from Mexico.│
└──────────────────────────┘

指定长度的替换

SELECT overlay('My father is from Mexico.', 'dad', 4, 6) AS res;

┌─res───────────────────┐
│ My dad is from Mexico.│
└───────────────────────┘

overlayUTF8

引入版本：v24.9.0

将字符串 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('Mein Vater ist aus Österreich.', 'der Türkei', 20) AS res;

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

printf

引入自：v24.8.0

printf 函数会使用参数中提供的值（字符串、整数、浮点数等）来格式化给定的字符串，类似于 C++ 中的 printf 函数。格式字符串中可以包含以 % 字符开头的格式说明符。不在 % 及其后续格式说明符中的任何内容都被视为字面文本，并原样复制到输出中。作为字面量使用的 % 字符可以通过 %% 进行转义。

语法

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

参数

format — 带有 % 说明符的格式字符串。String
sub1, sub2, ... — 可选。替换到格式字符串中的零个或多个值。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

为在正则表达式中具有特殊含义的以下字符添加反斜杠前缀：\0、\\、|、(、)、^、$、.、[、]、?、*、+、{、:、-。该实现与 re2::RE2::QuoteMeta 略有不同。它将零字节转义为 \0 而不是 \x00，并且只转义必要的字符。

语法

regexpQuoteMeta(s)

参数

s — 包含需要进行正则转义字符的输入字符串。String

返回值

返回一个已对正则表达式特殊字符完成转义的字符串。String

示例

转义正则表达式中的特殊字符

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

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

replaceAll

自 v1.1.0 起引入

将 haystack 中所有出现的 pattern 子串替换为字符串 replacement。

语法

replaceAll(haystack, pattern, replacement)

别名: replace

参数

haystack — 在其中搜索的输入字符串。String
pattern — 要查找并替换的子串。const String
replacement — 用于替换该子串的字符串。const String

返回值

返回一个字符串，其中所有匹配的子串都已被替换。String

示例

替换所有匹配项

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

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

replaceOne

自 v1.1.0 起引入

将 haystack 中第一次出现的子字符串 pattern 替换为字符串 replacement。

语法

replaceOne(haystack, pattern, replacement)

参数

haystack — 要在其中搜索的输入字符串。String
pattern — 要查找并替换的子串。const String
replacement — 用于替换该子串的字符串。const String

返回值

返回一个字符串，其中第一次出现的匹配子串被替换。String

示例

替换第一次出现的匹配项

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

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

replaceRegexpAll

自 v1.1.0 起引入

类似于 replaceRegexpOne，但会替换模式的所有匹配项。作为例外情况，如果某个正则表达式匹配到了空子串，则该替换最多只会执行一次。

语法

replaceRegexpAll(haystack, pattern, replacement)

别名: REGEXP_REPLACE

参数

haystack — 要在其中搜索的输入字符串。String
pattern — 要查找的正则表达式模式。const String
replacement — 用于替换该模式的字符串，可以包含替换引用。const String

返回值

返回一个字符串，其中所有正则匹配结果都已被替换。String

示例

将所有字符替换为其重复两次的版本

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

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

空字符串替换示例

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

┌─res─────────────────┐
│ here: Hello, World! │
└─────────────────────┘

replaceRegexpOne

引入版本：v1.1.0

将 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

复制字符串十次

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

┌─res────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Hello, World!Hello, World!Hello, World!Hello, World!Hello, World!Hello, World!Hello, World!Hello, World!Hello, World!Hello, World! │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

translate

引入版本：v22.7.0

使用由字符串 from 和 to 定义的一对一字符映射来替换字符串 s 中的字符。 from 和 to 必须是常量 ASCII 字符串。如果 from 和 to 的长度相同，则 s 中所有等于 from 中第一个字符的字符都会被替换为 to 中的第一个字符，s 中所有等于 from 中第二个字符的字符会被替换为 to 中的第二个字符，以此类推。如果 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───┐
│ CLICK │
└───────┘

translateUTF8

自 v22.7.0 起提供

与 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