2024 年 9 月 26 日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2

9.5. 二进制字符串函数和运算符 #

本节介绍用于检查和操作二进制字符串(即 bytea 类型的值)的函数和运算符。其中许多在目的和语法上等同于上一节介绍的文本字符串函数。

SQL定义了一些字符串函数,这些函数使用关键字而不是逗号来分隔参数。详情请参见 表 9.11PostgreSQL 还提供这些函数的版本,这些版本使用常规函数调用语法(参见 表 9.12)。

表 9.11. SQL二进制字符串函数和运算符

函数/运算符

描述

示例

bytea || byteabytea

连接两个二进制字符串。

'\x123456'::bytea || '\x789a00bcde'::bytea\x123456789a00bcde

bit_length ( bytea ) → integer

返回二进制字符串中的位数(octet_length 的 8 倍)。

bit_length('\x123456'::bytea)24

btrim ( bytes bytea, bytesremoved bytea ) → bytea

bytes 的开头和结尾移除最长的字符串,该字符串仅包含出现在 bytesremoved 中的字节。

btrim('\x1234567890'::bytea, '\x9012'::bytea)\x345678

ltrim ( bytes bytea, bytesremoved bytea ) → bytea

bytes 的开头移除最长的字符串,该字符串仅包含出现在 bytesremoved 中的字节。

ltrim('\x1234567890'::bytea, '\x9012'::bytea)\x34567890

octet_length ( bytea ) → integer

返回二进制字符串中的字节数。

octet_length('\x123456'::bytea)3

overlay ( bytes bytea PLACING newsubstring bytea FROM start integer [ FOR count integer ] ) → bytea

newsubstring 替换 bytes 中从第 start 个字节开始并扩展 count 个字节的子字符串。如果省略 count,则默认为 newsubstring 的长度。

overlay('\x1234567890'::bytea placing '\002\003'::bytea from 2 for 3)\x12020390

position ( substring bytea IN bytes bytea ) → integer

返回指定 substringbytes 中的第一个起始索引,如果不存在,则返回 0。

position('\x5678'::bytea in '\x1234567890'::bytea)3

rtrim ( bytes bytea, bytesremoved bytea ) → bytea

bytes 的结尾移除最长的字符串,该字符串仅包含出现在 bytesremoved 中的字节。

rtrim('\x1234567890'::bytea, '\x9012'::bytea)\x12345678

substring ( bytes bytea [ FROM start integer ] [ FOR count integer ] ) → bytea

提取 bytes 的子字符串,如果指定了 start,则从第 start 个字节开始,如果指定了 count,则在 count 个字节后停止。至少提供 startcount 之一。

substring('\x1234567890'::bytea from 3 for 2)\x5678

trim ( [ LEADING | TRAILING | BOTH ] bytesremoved bytea FROM bytes bytea ) → bytea

bytes 的开头、结尾或两端(BOTH 是默认值)移除最长的字符串,该字符串仅包含出现在 bytesremoved 中的字节。

trim('\x9012'::bytea from '\x1234567890'::bytea)\x345678

trim ( [ LEADING | TRAILING | BOTH ] [ FROM ] bytes bytea, bytesremoved bytea ) → bytea

这是 trim() 的非标准语法。

trim(both from '\x1234567890'::bytea, '\x9012'::bytea)\x345678


其他二进制字符串操作函数可用,并列在 表 9.12 中。其中一些用于内部实现SQL-标准字符串函数,这些函数列在 表 9.11 中。

表 9.12. 其他二进制字符串函数

函数

描述

示例

bit_count ( bytes bytea ) → bigint

返回二进制字符串中设置的位数(也称为 popcount)。

bit_count('\x1234567890'::bytea)15

get_bit ( bytes bytea, n bigint ) → integer

从二进制字符串中提取第 n 个位。

get_bit('\x1234567890'::bytea, 30)1

get_byte ( bytes bytea, n integer ) → integer

从二进制字符串中提取第 n 个字节。

get_byte('\x1234567890'::bytea, 4)144

length ( bytea ) → integer

返回二进制字符串中的字节数。

length('\x1234567890'::bytea)5

length ( bytes bytea, encoding name ) → integer

返回二进制字符串中的字符数,假设它是以给定 encoding 的文本。

length('jose'::bytea, 'UTF8')4

md5 ( bytea ) → text

计算二进制字符串的 MD5 哈希,结果以十六进制形式写入。

md5('Th\000omas'::bytea)8ab2d3c9689aaf18​b4958c334c82d8b1

set_bit ( bytes bytea, n bigint, newvalue integer ) → bytea

将二进制字符串中的第 n 位设置为 newvalue

set_bit('\x1234567890'::bytea, 30, 0)\x1234563890

set_byte ( bytes bytea, n integer, newvalue integer ) → bytea

将二进制字符串中的第 n 个字节设置为 newvalue

set_byte('\x1234567890'::bytea, 4, 64)\x1234567840

sha224 ( bytea ) → bytea

计算二进制字符串的 SHA-224 哈希

sha224('abc'::bytea)\x23097d223405d8228642a477bda2​55b32aadbce4bda0b3f7e36c9da7

sha256 ( bytea ) → bytea

计算二进制字符串的 SHA-256 哈希

sha256('abc'::bytea)\xba7816bf8f01cfea414140de5dae2223​b00361a396177a9cb410ff61f20015ad

sha384 ( bytea ) → bytea

计算二进制字符串的 SHA-384 哈希

sha384('abc'::bytea)\xcb00753f45a35e8bb5a03d699ac65007​272c32ab0eded1631a8b605a43ff5bed​8086072ba1e7cc2358baeca134c825a7

sha512 ( bytea ) → bytea

计算二进制字符串的 SHA-512 哈希

sha512('abc'::bytea)\xddaf35a193617abacc417349ae204131​12e6fa4e89a97ea20a9eeee64b55d39a​2192992a274fc1a836ba3c23a3feebbd​454d4423643ce80e2a9ac94fa54ca49f

substr ( bytes bytea, start integer [, count integer ] ) → bytea

提取 bytes 从第 start 个字节开始的子字符串,如果指定了 count,则扩展到 count 个字节。(与 substring(bytes from start for count) 相同。)

substr('\x1234567890'::bytea, 3, 2)\x5678


函数 get_byteset_byte 将二进制字符串的第一个字节编号为字节 0。函数 get_bitset_bit 从每个字节的右侧开始对位进行编号;例如,位 0 是第一个字节的最低有效位,而位 15 是第二个字节的最高有效位。

出于历史原因,函数 md5 返回类型为 text 的十六进制编码值,而 SHA-2 函数返回类型为 bytea。使用函数 encodedecode 在两者之间进行转换。例如,编写 encode(sha256('abc'), 'hex') 以获取十六进制编码的文本表示,或者编写 decode(md5('abc'), 'hex') 以获取 bytea 值。

表 9.13 中显示了用于在不同字符集(编码)之间转换字符串以及用于以文本形式表示任意二进制数据的函数。对于这些函数,类型为 text 的参数或结果以数据库的默认编码表示,而类型为 bytea 的参数或结果以另一个参数命名的编码表示。

表 9.13. 文本/二进制字符串转换函数

函数

描述

示例

convert ( bytes bytea, src_encoding name, dest_encoding name ) → bytea

将表示以 src_encoding 编码的文本的二进制字符串转换为以 dest_encoding 编码的二进制字符串(有关可用的转换,请参阅 第 23.3.4 节)。

convert('text_in_utf8', 'UTF8', 'LATIN1')\x746578745f696e5f75746638

convert_from ( bytes bytea, src_encoding name ) → text

将表示以 src_encoding 编码的文本的二进制字符串转换为以数据库编码的 text(有关可用的转换,请参阅 第 23.3.4 节)。

convert_from('text_in_utf8', 'UTF8')text_in_utf8

convert_to ( string text, dest_encoding name ) → bytea

text 字符串(以数据库编码)转换为以 dest_encoding 编码的二进制字符串(有关可用的转换,请参阅 第 23.3.4 节)。

convert_to('some_text', 'UTF8')\x736f6d655f74657874

encode ( bytes bytea, format text ) → text

将二进制数据编码为文本表示;支持的 format 值为:base64escapehex

encode('123\000\001', 'base64')MTIzAAE=

decode ( string text, format text ) → bytea

从文本表示中解码二进制数据;支持的 format 值与 encode 相同。

decode('MTIzAAE=', 'base64')\x3132330001


函数 encodedecode 支持以下文本格式

base64 #

base64 格式是 RFC 2045 第 6.8 节 中的格式。根据RFC,编码行在 76 个字符处换行。但是,与 MIME CRLF 行结束标记不同,仅使用换行符作为行结束符。函数 decode 会忽略回车符、换行符、空格符和制表符。否则,当 decode 提供无效的 base64 数据时(包括当尾部填充不正确时),会引发错误。

escape #

escape 格式将零字节和高位设定的字节转换为八进制转义序列 (\nnn),并将反斜杠加倍。其他字节值按字面形式表示。如果反斜杠后面不是第二个反斜杠或三个八进制数字,则函数 decode 会引发错误;它接受其他字节值不变。

hex #

hex 格式将数据中的每 4 位表示为一个十六进制数字,从 0f,先写入每个字节的高位数字。由于数据的最小单位是 8 位,因此函数 encode 返回的字符数总是偶数。函数 decode 接受 a-f 字符,无论大小写。当 decode 给出无效的十六进制数据时(包括给出奇数个字符时),会引发错误。

另请参阅 第 9.21 节 中的聚合函数 string_agg 以及 第 33.4 节 中的大对象函数。

提交更正

如果您在文档中发现任何不正确的内容、与您对特定功能的体验不符或需要进一步说明,请使用 此表格 报告文档问题。