<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pgsql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.pg-prepare.php',
    1 => 'pg_prepare',
    2 => 'Отправляет на сервер запрос на подготовку SQL-запроса с параметрами-заполнителями
   и ждёт, пока завершится подготовка запроса',
  ),
  'up' => 
  array (
    0 => 'ref.pgsql.php',
    1 => 'Функции PostgreSQL',
  ),
  'prev' => 
  array (
    0 => 'function.pg-port.php',
    1 => 'pg_port',
  ),
  'next' => 
  array (
    0 => 'function.pg-put-line.php',
    1 => 'pg_put_line',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/pgsql/functions/pg-prepare.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.pg-prepare" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">pg_prepare</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">pg_prepare</span> &mdash; <span class="dc-title">
   Отправляет на сервер запрос на подготовку SQL-запроса с параметрами-заполнителями
   и ждёт, пока завершится подготовка запроса
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.pg-prepare-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>pg_prepare</strong></span>(<span class="methodparam"><span class="type"><a href="class.pgsql-connection.php" class="type PgSql\Connection">PgSql\Connection</a></span> <code class="parameter">$connection</code><span class="initializer"> = ?</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$stmtname</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$query</code></span>): <span class="type"><span class="type"><a href="class.pgsql-result.php" class="type PgSql\Result">PgSql\Result</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Функция <span class="function"><strong>pg_prepare()</strong></span> подготавливает SQL-запрос,
   который затем запустит функция <span class="function"><a href="function.pg-execute.php" class="function">pg_execute()</a></span>
   или <span class="function"><a href="function.pg-send-execute.php" class="function">pg_send_execute()</a></span>. Функция помогает разбирать
   и планировать команды только один раз, а не каждый раз при выполнении,
   а потом многократно выполнять такие команды.
   Функция <span class="function"><strong>pg_prepare()</strong></span> поддерживает соединения только с БД PostgreSQL 7.4
   или новее; функция не будет работать c серверами предыдущих версий.
  </p>
  <p class="para">
   Функция создает подготовленный запрос с названием <code class="parameter">stmtname</code>
   из строки <code class="parameter">query</code>, которая содержит одну команду.
   Значение параметра <code class="parameter">stmtname</code> указывают как пустую строку <code class="literal">&quot;&quot;</code>,
   чтобы создать безымянный запрос, который автоматически заменяет предыдущий безымянный запрос;
   в остальных случаях попытка назвать запрос именем, которое уже определили в текущей сессии,
   вызовет ошибку. Параметры, которые передали при выполнении запроса,
   указывают на обозначения <code class="literal">$1</code>, <code class="literal">$2</code> и т. д. в запросе <code class="parameter">query</code>.
  </p>
  <p class="para">
   Подготовленные для функции <span class="function"><strong>pg_prepare()</strong></span> запросы создают также SQL-командой
   <code class="literal">PREPARE</code>, но функция <span class="function"><strong>pg_prepare()</strong></span> гибче,
   поскольку не заставляет указывать типы параметров.
   Хотя в PHP нет функции для удаления подготовленного запроса,
   это сделает SQL-команда <code class="literal">DEALLOCATE</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.pg-prepare-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection</code></dt>
     <dd>
      <p class="para">Экземпляр
класса <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>.
Функция выберет соединение по умолчанию, если параметр <code class="parameter">connection</code> не указали.
Соединение по умолчанию — последнее соединение, которое установила функция <span class="function"><a href="function.pg-connect.php" class="function">pg_connect()</a></span>
или <span class="function"><a href="function.pg-pconnect.php" class="function">pg_pconnect()</a></span>.
<div class="warning"><strong class="warning">Внимание</strong><p class="simpara">Начиная с PHP 8.1.0 выбор функцией соединения по умолчанию устарел.</p></div></p>
     </dd>
    
    
     <dt><code class="parameter">stmtname</code></dt>
     <dd>
      <p class="para">
       Уникальное в пределах сессии имя, которым функция назовёт подготовленный запрос.
       Функция создаст безымянный запрос, который перезапишет предыдущий безымянный запрос
       текущей сессии, если задали пустую строку <code class="literal">&quot;&quot;</code>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">query</code></dt>
     <dd>
      <p class="para">
       Один параметризованный SQL-запрос; несколько запросов через точку с запятой не поддерживаются.
       Параметры, которые передали, относятся к обозначениям запроса <code class="literal">$1</code>, <code class="literal">$2</code> и т. д.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.pg-prepare-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает экземпляр <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span> в случае успешного выполнения или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.pg-prepare-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  Функция возвращает экземпляр класса <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span>;
  раньше функция возвращала ресурс (<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>).
 </td>
</tr>

     <tr>
 <td>8.1.0</td>
 <td>
  Параметр <code class="parameter">connection</code> теперь принимает
  объект <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>; раньше параметр принимал тип <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.pg-prepare-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример подготовки запроса функцией <span class="function"><strong>pg_prepare()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// Подключение к базе данных "mary"<br /></span><span style="color: #0000BB">$dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=mary"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Подготовка запроса<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_query"</span><span style="color: #007700">, </span><span style="color: #DD0000">'SELECT * FROM shops WHERE name = $1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Запуск запроса на выполнение. Обратите внимание: спецсимволы в строке "Joe's Widgets"<br />// не заэкранированы<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_query"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"Joe's Widgets"</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Запуск на выполнение того же запроса, но с другим параметром<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_query"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"Clothes Clothes Clothes"</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.pg-prepare-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.pg-execute.php" class="function" rel="rdfs-seeAlso">pg_execute()</a> - Запускает выполнение ранее подготовленного параметризованного запроса и ждёт результат</span></li>
    <li><span class="function"><a href="function.pg-send-execute.php" class="function" rel="rdfs-seeAlso">pg_send_execute()</a> - Запускает предварительно подготовленный SQL-запрос и
   передаёт ему параметры; не ожидает возвращаемого результата</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>