mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update examples for string-related functions.

Browse Source 
In the example for decode(), show the bytea result in hex format,
since that's now the default.  Use an E'' string in the example for
quote_literal(), so that it works regardless of the
standard_conforming_strings setting.  On the functions-for-binary-strings
page, leave the examples as-is for readability, but add a note pointing out
that they are shown in escape format.  Per comments from Thom Brown.

Also, improve the description for encode() and decode() a tad.

Backpatch to 9.0, where bytea_output was introduced.
This commit is contained in:
Tom Lane 2011-07-07 19:34:19 -04:00
parent 997d5b488a
commit c59b8ba6cd
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/src/sgml/func.sgml
View File

@ -1482,15 +1482,15 @@
<primary>decode</primary> <primary>decode</primary>
</indexterm> </indexterm>
<literal><function>decode(<parameter>string</parameter> <type>text</type>, <literal><function>decode(<parameter>string</parameter> <type>text</type>,
<parameter>type</parameter> <type>text</type>)</function></literal> <parameter>format</parameter> <type>text</type>)</function></literal>
</entry> </entry>
<entry><type>bytea</type></entry> <entry><type>bytea</type></entry>
<entry> <entry>
Decode binary data from <parameter>string</parameter> previously Decode binary data from textual representation in <parameter>string</>.
encoded with <function>encode</>. Parameter type is same as in <function>encode</>. Options for <parameter>format</> are same as in <function>encode</>.
</entry> </entry>
<entry><literal>decode('MTIzAAE=', 'base64')</literal></entry> <entry><literal>decode('MTIzAAE=', 'base64')</literal></entry>
<entry><literal>123\000\001</literal></entry> <entry><literal>\x3132330001</literal></entry>
</row> </row>
<row> <row>
@ -1499,13 +1499,13 @@
<primary>encode</primary> <primary>encode</primary>
</indexterm> </indexterm>
<literal><function>encode(<parameter>data</parameter> <type>bytea</type>, <literal><function>encode(<parameter>data</parameter> <type>bytea</type>,
<parameter>type</parameter> <type>text</type>)</function></literal> <parameter>format</parameter> <type>text</type>)</function></literal>
</entry> </entry>
<entry><type>text</type></entry> <entry><type>text</type></entry>
<entry> <entry>
Encode binary data to different representation. Supported Encode binary data into a textual representation. Supported
types are: <literal>base64</>, <literal>hex</>, <literal>escape</>. formats are: <literal>base64</>, <literal>hex</>, <literal>escape</>.
<literal>Escape</> merely outputs null bytes as <literal>\000</> and <literal>escape</> merely outputs null bytes as <literal>\000</> and
doubles backslashes. doubles backslashes.
</entry> </entry>
<entry><literal>encode(E'123\\000\\001', 'base64')</literal></entry> <entry><literal>encode(E'123\\000\\001', 'base64')</literal></entry>
@ -1707,7 +1707,7 @@
<function>quote_nullable</function> is often more suitable. <function>quote_nullable</function> is often more suitable.
See also <xref linkend="plpgsql-quote-literal-example">. See also <xref linkend="plpgsql-quote-literal-example">.
</entry> </entry>
<entry><literal>quote_literal('O\'Reilly')</literal></entry> <entry><literal>quote_literal(E'O\'Reilly')</literal></entry>
<entry><literal>'O''Reilly'</literal></entry> <entry><literal>'O''Reilly'</literal></entry>
</row> </row>
@ -2859,6 +2859,14 @@
(see <xref linkend="functions-binarystring-other">). (see <xref linkend="functions-binarystring-other">).
</para> </para>
<note>
<para>
The sample results shown on this page assume that the server parameter
<link linkend="guc-bytea-output"><varname>bytea_output</></link> is set
to <literal>escape</literal> (the traditional PostgreSQL format).
</para>
</note>
<table id="functions-binarystring-sql"> <table id="functions-binarystring-sql">
<title><acronym>SQL</acronym> Binary String Functions and Operators</title> <title><acronym>SQL</acronym> Binary String Functions and Operators</title>
<tgroup cols="5"> <tgroup cols="5">