PostgreSQL : Документация: 12: 9.5. Функции и операторы двоичных строк : Компания Postgres Professional

9.5. Функции и операторы двоичных строк
Пред.	Наверх	Глава 9. Функции и операторы	Начало	След.

9.5. Функции и операторы двоичных строк

В этом разделе описываются функции и операторы для работы с данными типа bytea.

В SQL определены несколько строковых функций, в которых аргументы разделяются не запятыми, а ключевыми словами. Подробнее это описано в Таблице 9.12. PostgreSQL также предоставляет варианты этих функций с синтаксисом, обычным для функций (см. Таблицу 9.13).

Примечание

В примерах, приведённых на этой странице, подразумевается, что параметр сервера bytea_output равен escape (выбран традиционный формат PostgreSQL).

Таблица 9.12. SQL-функции и операторы для работы с двоичными строками

Функция	Тип результата	Описание	Пример	Результат
`string \|\| string`	`bytea`	Конкатенация строк	`'\\Post'::bytea \|\| '\047gres\000'::bytea`	`\\Post'gres\000`
`octet_length(string)`	`int`	Число байт в двоичной строке	`octet_length('jo\000se'::bytea)`	`5`
`overlay(string placing string from int [for int])`	`bytea`	Заменяет подстроку	`overlay('Th\000omas'::bytea placing '\002\003'::bytea from 2 for 3)`	`T\\002\\003mas`
`position(substring in string)`	`int`	Положение указанной подстроки	`position('\000om'::bytea in 'Th\000omas'::bytea)`	`3`
`substring(string [from int] [for int])`	`bytea`	Извлекает подстроку	`substring('Th\000omas'::bytea from 2 for 3)`	`h\000o`
`trim([both] bytes from string)`	`bytea`	Удаляет наибольшую строку, содержащую только байты, заданные в параметре `bytes`, с начала и с конца строки `string`	`trim('\000\001'::bytea from '\000Tom\001'::bytea)`	`Tom`

В PostgreSQL есть и другие функции для работы с двоичными строками, перечисленные в Таблице 9.13. Некоторые из них используются в качестве внутренней реализации стандартных функций SQL, приведённых в Таблице 9.12.

Таблица 9.13. Другие функции для работы с двоичными строками

Функция	Тип результата	Описание	Пример	Результат
`btrim(string bytea, bytes bytea)`	`bytea`	Удаляет наибольшую строку, содержащую только байты, заданные в параметре `bytes`, с начала и с конца строки `string`	`btrim('\000trim\001'::bytea, '\000\001'::bytea)`	`trim`
`decode(string text, format text)`	`bytea`	Получает двоичные данные из текстового представления в `string`. Значения параметра `format` те же, что и для функции `encode`.	`decode('123\000456', 'escape')`	`123\000456`
`encode(data bytea, format text)`	`text`	Переводит двоичные данные в текстовое представление в одном из форматов: `base64`, `hex`, `escape`. Формат `escape` преобразует нулевые байты и байты с 1 в старшем бите в восьмеричные последовательности `\nnn` и дублирует обратную косую черту.	`encode('123\000456'::bytea, 'escape')`	`123\000456`
`get_bit(string, offset)`	`int`	Извлекает бит из строки	`get_bit('Th\000omas'::bytea, 45)`	`1`
`get_byte(string, offset)`	`int`	Извлекает байт из строки	`get_byte('Th\000omas'::bytea, 4)`	`109`
`length(string)`	`int`	Длина двоичной строки	`length('jo\000se'::bytea)`	`5`
`md5(string)`	`text`	Вычисляет MD5-хеш строки `string` и возвращает результат в 16-ричном виде	`md5('Th\000omas'::bytea)`	`8ab2d3c9689aaf18b4958c334c82d8b1`
`set_bit(string, offset, newvalue)`	`bytea`	Устанавливает значение бита в строке	`set_bit('Th\000omas'::bytea, 45, 0)`	`Th\000omAs`
`set_byte(string, offset, newvalue)`	`bytea`	Устанавливает значение байта в строке	`set_byte('Th\000omas'::bytea, 4, 64)`	`Th\000o@as`
`sha224(bytea)`	`bytea`	Хеш SHA-224	`sha224('abc')`	`\x23097d223405d8228642a477bda255b32aadbce4bda0b3f7e36c9da7`
`sha256(bytea)`	`bytea`	Хеш SHA-256	`sha256('abc')`	`\xba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad`
`sha384(bytea)`	`bytea`	Хеш SHA-384	`sha384('abc')`	`\xcb00753f45a35e8bb5a03d699ac65007272c32ab0eded1631a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7`
`sha512(bytea)`	`bytea`	Хеш SHA-512	`sha512('abc')`	`\xddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f`

Для функций get_byte и set_byte байты нумеруется с 0. Функции get_bit и set_bit нумеруют биты справа налево; например, бит 0 будет меньшим значащим битом первого байта, а бит 15 — большим значащим битом второго байта.

Заметьте, что по историческим причинам функция md5 возвращает значение в шестнадцатеричном виде в типе text, тогда как функции SHA-2 возвращают тип bytea. Используйте функции encode и decode для преобразования значений из одного представления в другое. Например, вызвав encode(sha256('abc'), 'hex'), вы получите значение в шестнадцатеричном виде в строке.

См. также агрегатную функцию string_agg в Разделе 9.20 и функции для работы с большими объектами в Разделе 34.4.

Пред.	Наверх	След.
9.4. Строковые функции и операторы	Начало	9.6. Функции и операторы для работы с битовыми строками

9.5. Binary String Functions and Operators
Prev	Up	Chapter 9. Functions and Operators	Home	Next

9.5. Binary String Functions and Operators

This section describes functions and operators for examining and manipulating values of type bytea.

SQL defines some string functions that use key words, rather than commas, to separate arguments. Details are in Table 9.12. PostgreSQL also provides versions of these functions that use the regular function invocation syntax (see Table 9.13).

Note

The sample results shown on this page assume that the server parameter bytea_output is set to escape (the traditional PostgreSQL format).

Table 9.12. SQL Binary String Functions and Operators

Function	Return Type	Description	Example	Result
`string \|\| string`	`bytea`	String concatenation	`'\\Post'::bytea \|\| '\047gres\000'::bytea`	`\\Post'gres\000`
`octet_length(string)`	`int`	Number of bytes in binary string	`octet_length('jo\000se'::bytea)`	`5`
`overlay(string placing string from int [for int])`	`bytea`	Replace substring	`overlay('Th\000omas'::bytea placing '\002\003'::bytea from 2 for 3)`	`T\\002\\003mas`
`position(substring in string)`	`int`	Location of specified substring	`position('\000om'::bytea in 'Th\000omas'::bytea)`	`3`
`substring(string [from int] [for int])`	`bytea`	Extract substring	`substring('Th\000omas'::bytea from 2 for 3)`	`h\000o`
`trim([both] bytes from string)`	`bytea`	Remove the longest string containing only bytes appearing in `bytes` from the start and end of `string`	`trim('\000\001'::bytea from '\000Tom\001'::bytea)`	`Tom`

Additional binary string manipulation functions are available and are listed in Table 9.13. Some of them are used internally to implement the SQL-standard string functions listed in Table 9.12.

Table 9.13. Other Binary String Functions

Function	Return Type	Description	Example	Result
`btrim(string bytea, bytes bytea)`	`bytea`	Remove the longest string containing only bytes appearing in `bytes` from the start and end of `string`	`btrim('\000trim\001'::bytea, '\000\001'::bytea)`	`trim`
`decode(string text, format text)`	`bytea`	Decode binary data from textual representation in `string`. Options for `format` are same as in `encode`.	`decode('123\000456', 'escape')`	`123\000456`
`encode(data bytea, format text)`	`text`	Encode binary data into a textual representation. Supported formats are: `base64`, `hex`, `escape`. `escape` converts zero bytes and high-bit-set bytes to octal sequences (`\``nnn`) and doubles backslashes.	`encode('123\000456'::bytea, 'escape')`	`123\000456`
`get_bit(string, offset)`	`int`	Extract bit from string	`get_bit('Th\000omas'::bytea, 45)`	`1`
`get_byte(string, offset)`	`int`	Extract byte from string	`get_byte('Th\000omas'::bytea, 4)`	`109`
`length(string)`	`int`	Length of binary string	`length('jo\000se'::bytea)`	`5`
`md5(string)`	`text`	Calculates the MD5 hash of `string`, returning the result in hexadecimal	`md5('Th\000omas'::bytea)`	`8ab2d3c9689aaf18b4958c334c82d8b1`
`set_bit(string, offset, newvalue)`	`bytea`	Set bit in string	`set_bit('Th\000omas'::bytea, 45, 0)`	`Th\000omAs`
`set_byte(string, offset, newvalue)`	`bytea`	Set byte in string	`set_byte('Th\000omas'::bytea, 4, 64)`	`Th\000o@as`
`sha224(bytea)`	`bytea`	SHA-224 hash	`sha224('abc')`	`\x23097d223405d8228642a477bda255b32aadbce4bda0b3f7e36c9da7`
`sha256(bytea)`	`bytea`	SHA-256 hash	`sha256('abc')`	`\xba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad`
`sha384(bytea)`	`bytea`	SHA-384 hash	`sha384('abc')`	`\xcb00753f45a35e8bb5a03d699ac65007272c32ab0eded1631a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7`
`sha512(bytea)`	`bytea`	SHA-512 hash	`sha512('abc')`	`\xddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f`

get_byte and set_byte number the first byte of a binary string as byte 0. get_bit and set_bit number bits from the right within each byte; for example bit 0 is the least significant bit of the first byte, and bit 15 is the most significant bit of the second byte.

Note that for historic reasons, the function md5 returns a hex-encoded value of type text whereas the SHA-2 functions return type bytea. Use the functions encode and decode to convert between the two, for example encode(sha256('abc'), 'hex') to get a hex-encoded text representation.

See also the aggregate function string_agg in Section 9.20 and the large object functions in Section 34.4.

Prev	Up	Next
9.4. String Functions and Operators	Home	9.6. Bit String Functions and Operators