pg-query-params.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-query-params" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_query_params</refname>
  <refpurpose>
   Посылает параметризованный запрос на сервер, параметры передаются отдельно от текста SQL запроса
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_query_params</methodname>
   <methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam><type>array</type><parameter>params</parameter></methodparam>
  </methodsynopsis>
  <para>
   Посылает параметризованный запрос на сервер и ждёт результат.
   Параметры передаются отдельно от строки запроса.
  </para>
  <para>
   <function>pg_query_params</function> подобна функции <function>pg_query</function>,
   но предоставляет дополнительный функционал: параметры запроса можно передавать
   отдельно от строки запроса. <function>pg_query_params</function> поддерживается
   на соединениях с серверами PostgreSQL версий 7.4 и выше. Функция не будет работать
   с серверами ранних версий.
  </para>
  <para>
   Если используются параметры <parameter>params</parameter>, они заменяют
   псевдопеременные $1, $2 и т.д. в строке запроса <parameter>query</parameter>.
   Один и тот же параметр может быть указан больше одного раза в <parameter>query</parameter>;
   в этом случае будут использованы одинаковые значения. <parameter>params</parameter> определяют
   текущие значения параметров. Значение &null; в массиве параметров будет означать
   SQL <literal>NULL</literal> в запросе.
  </para>
  <para>
   Главное преимущество <function>pg_query_params</function> перед
   <function>pg_query</function> заключается в том, что значения параметров могут
   передаваться отдельно от строки запроса <parameter>query</parameter>. Это даёт
   возможность избежать утомительную и подверженную ошибкам процедуру экранирования
   спецсимволов и заключения значений в кавычки. Однако, в отличие от
   <function>pg_query</function>, эта функция поддерживает только один SQL запрос
   в передаваемой строке. (Он может содержать точку с запятой, но не более одной
   непустой SQL-команды.)
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection-with-unspecified-default;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       Параметризованный SQL запрос. Должен содержать только одно выражение
       (несколько выражений разделённых точкой с запятой не поддерживаются).
       Если в запрос будут передаваться параметры, то они заменят
       псевдопеременные $1, $2 и т.д.
      </para>
      <para>
       Пользовательские данные всегда должны передаваться как параметры,
       и не передаваться в строку запроса напрямую, где они могут привести
       к возможным атакам через
       <link linkend="security.database.sql-injection">SQL-инъекции</link>
       и приводит к ошибкам, если данные содержат кавычки.
       Если по каким-то причинам вы не можете использовать параметр, убедитесь, что
       пользовательские данные <link linkend="function.pg-escape-string">правильно экранированы</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
       Массив значений параметров запроса для замены псевдопеременных $1, $2 и т.д.
       в исходной строке запроса. Количество элементов массива должно точно совпадать с
       количеством псевдопеременных.
      </para>
      <para>
       Значения предназначенные для <literal>bytea</literal> полей нельзя передавать в параметрах.
       Используйте функцию <function>pg_escape_bytea</function> или функции для больших объектов.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Экземпляр <classname>PgSql\Result</classname> в случае успешного выполнения&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.return-result-object;
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>pg_query_params</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Подключение к базе данных "mary"
$dbconn = pg_connect("dbname=mary");

// Найдём все магазины с названием "Joe's Widgets". Стоит отметить, что нет необходимости экранировать
// спецсимволы в строке "Joe's Widgets"
$result = pg_query_params($dbconn, 'SELECT * FROM shops WHERE name = $1', array("Joe's Widgets"));

// Для сравнения то же самое, используя функцию pg_query
$str = pg_escape_string("Joe's Widgets");
$result = pg_query($dbconn, "SELECT * FROM shops WHERE name = '{$str}'");

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_query</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:"~/.phpdoc/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
-->