mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
7ee0a65fca
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189840 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.2 KiB
XML
120 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
|
|
<refentry id='function.pg-escape-bytea'>
|
|
<refnamediv>
|
|
<refname>pg_escape_bytea</refname>
|
|
<refpurpose>
|
|
Escape a string for insertion into a bytea field
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>pg_escape_bytea</methodname>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>pg_escape_bytea</function> escapes string for
|
|
bytea datatype. It returns escaped string.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
When you <literal>SELECT</literal> a bytea type, PostgreSQL returns octal byte values
|
|
prefixed with '\' (e.g. \032). Users are supposed to convert back to
|
|
binary format manually.
|
|
</para>
|
|
<para>
|
|
This function requires PostgreSQL 7.2 or later. With PostgreSQL
|
|
7.2.0 and 7.2.1, bytea values must be cast when you enable
|
|
multi-byte support. i.e. <literal>INSERT INTO test_table (image)
|
|
VALUES ('$image_escaped'::bytea);</literal> PostgreSQL 7.2.2 or
|
|
later does not need a cast. The exception is when the client and backend
|
|
character encoding does not match, and there may be multi-byte
|
|
stream error. User must then cast to bytea to avoid this error.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A <type>string</type> containing text or binary data to be inserted into a bytea
|
|
column.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A <type>string</type> containing the escaped data.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pg_escape_bytea</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Connect to the database
|
|
$dbconn = pg_connect('dbname=foo');
|
|
|
|
// Read in a binary file
|
|
$data = file_get_contents('image1.jpg');
|
|
|
|
// Escape the binary data
|
|
$escaped = pg_escape_bytea($data);
|
|
|
|
// Insert it into the database
|
|
pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', '{$escaped}')";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>pg_unescape_bytea</function></member>
|
|
<member><function>pg_escape_string</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|