7.3. Binary Data

The BYTEA data type allows storage of binary strings; see Table 7-4.

A binary string is a sequence of octets (or bytes). Binary strings are distinguished from characters strings by two characteristics: First, binary strings specifically allow storing octets of value zero and other "non-printable" octets (defined as octets outside the range 32 to 126). Second, operations on binary strings process the actual bytes, whereas the encoding and processing of character strings depends on locale settings.

When entering bytea values, octets of certain values must be escaped (but all octet values can be escaped) when used as part of a string literal in an SQL statement. In general, to escape an octet, it is converted into the three-digit octal number equivalent of its decimal octet value, and preceded by two backslashes (or one backslash if standard_conforming_strings is off). Table 7-5 shows the characters that must be escaped, and gives the alternate escape sequences where applicable.

The requirement to escape "non-printable" octets actually varies depending on locale settings. In some instances you can get away with leaving them unescaped. Note that the result in each of the examples in Table 7-5 was exactly one octet in length, even though the output representation of the zero octet and backslash are more than one character.

The reason that you have to write so many backslashes, as shown in Table 7-5, is that an input string written as a string literal must pass through two parse phases in the EnterpriseDB server. The first backslash of each pair is interpreted as an escape character by the string-literal parser (assuming standard_conforming_strings is off) and is therefore consumed, leaving the second backslash of the pair. The remaining backslash is then recognized by the bytea input function as starting either a three digit octal value or escaping another backslash. For example, a string literal passed to the server as '\\001' becomes \001 after passing through the string-literal parser. The \001 is then sent to the bytea input function, where it is converted to a single octet with a decimal value of 1. Note that the apostrophe character is not treated specially by bytea, so it follows the normal rules for string literals. (See also Section 3.1.2.1.)

BYTEA octets are also escaped in the output. In general, each "non-printable" octet is converted into its equivalent three-digit octal value and preceded by one backslash. Most "printable" octets are represented by their standard representation in the client character set. The octet with decimal value 92 (backslash) has a special alternative output representation. Details are in Table 7-6.

Depending on the front end to EnterpriseDB you use, you may have additional work to do in terms of escaping and unescaping BYTEA strings. For example, you may also have to escape line feeds and carriage returns if your interface automatically translates these.

The following can be used as synonyms for BYTEA: BINARY, BLOB, BYTE, IMAGE, LONG RAW, RAW (n), and VARBINARY.