<?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 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.pg-prepare.php',
    1 => 'pg_prepare',
    2 => 'Envoie une requ&ecirc;te au serveur pour cr&eacute;er une instruction pr&eacute;par&eacute;e avec les param&egrave;tres
   donn&eacute;s et attend l\'ex&eacute;cution',
  ),
  'up' => 
  array (
    0 => 'ref.pgsql.php',
    1 => 'pg_cancel_query',
  ),
  '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' => 'fr',
    '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">
   Envoie une requête au serveur pour créer une instruction préparée avec les paramètres
   donnés et attend l&#039;exécution
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.pg-prepare-description">
  <h3 class="title">Description</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">$statement_name</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> crée une requête préparée pour une
   exécution ultérieure avec <span class="function"><a href="function.pg-execute.php" class="function">pg_execute()</a></span> ou
   <span class="function"><a href="function.pg-send-execute.php" class="function">pg_send_execute()</a></span>. 
   Cette caractéristique permet aux commandes qui seront utilisées à
   plusieurs reprises d&#039;être analysées et planifiées qu&#039;une seule fois,
   plutôt que d&#039;être exécutées chaque fois.
  </p>
  <p class="para">
   La fonction crée une requête préparée nommée
   <code class="parameter">statement_name</code> à partir de la chaîne
   <code class="parameter">query</code>, celle-ci ne doit contenir qu&#039;une seule commande
   SQL. <code class="parameter">statement_name</code> peut être <code class="literal">&quot;&quot;</code> pour créer une
   requête qui n&#039;est pas nommée. Dans ce cas, les requêtes qui existaient et
   qui se trouvaient sans noms sont automatiquement remplacées; autrement, il y
   aura une erreur si le nom de la requête est déjà défini dans la session
   courante. Si des paramètres sont utilisés, ils sont référés à <code class="literal">$1</code>,
   <code class="literal">$2</code>, etc.
   dans <code class="parameter">query</code>.
  </p>
  <p class="para">
   Des requêtes préparées à utiliser avec <span class="function"><strong>pg_prepare()</strong></span>
   peuvent être aussi créées en exécutant la requête SQL
   <code class="literal">PREPARE</code>. (Par contre, <span class="function"><strong>pg_prepare()</strong></span>
   est plus flexible puisqu&#039;elle ne nécessite pas que les types des paramètres
   soient préspécifiés.) De plus, bien qu&#039;il n&#039;y ait pas de fonction PHP pour
   supprimer une requête préparée, la requête SQL
   <code class="literal">DEALLOCATE</code> peut être utilisée pour ce motif.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.pg-prepare-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection</code></dt>
     <dd>
      <p class="para">
 Une instance <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>.
 Quand <code class="parameter">connection</code> est pas spécifié, la connexion par défaut est utilisé.
 La connexion par défaut est la dernière connexion faite par
 <span class="function"><a href="function.pg-connect.php" class="function">pg_connect()</a></span> ou <span class="function"><a href="function.pg-pconnect.php" class="function">pg_pconnect()</a></span>
 <div class="warning"><strong class="warning">Avertissement</strong><p class="simpara">À partir de PHP 8.1.0, utiliser la connexion par défaut est obsolète.</p></div>
</p>
     </dd>
    
    
     <dt><code class="parameter">statement_name</code></dt>
     <dd>
      <p class="para">
       Le nom à donner à la requête préparée. Il doit être unique à chaque
       session. Si une chaîne vide est spécifiée <code class="literal">&quot;&quot;</code> alors une requête sans
       nom est créée, écrasant les requêtes sans noms précédemment définies.
      </p>
     </dd>
    
    
     <dt><code class="parameter">query</code></dt>
     <dd>
      <p class="para">
       La requête SQL avec ses paramètres. Elle doit contenir seulement une seule
       requête. Plusieurs requêtes séparées par des points-virgules ne sont
       pas autorisées. Si des paramètres sont utilisés, ils sont référés à
       <code class="literal">$1</code>, <code class="literal">$2</code>, etc.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.pg-prepare-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Une instance <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span> en cas de succès,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.pg-prepare-changelog">
  <h3 class="title">Historique</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  Retourne désormais une instance de <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span> instance ;
  auparavant, une <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> était retourné.
 </td>
</tr>

     <tr>
 <td>8.1.0</td>
 <td>
  Le paramètre <code class="parameter">connection</code> attend désormais une instance de
  <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span> ; auparavant, une <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> était attendu.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>

 
 <div class="refsect1 examples" id="refsect1-function.pg-prepare-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Exemple avec <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 /></span><span style="color: #FF8000">// Connexion à une base de données nommée "marie"<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=marie"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Prépare une requête pour l'exécution<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 magasins WHERE nom = $1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Exécute la requête préparée. À noter qu'il n'est pas nécessaire d'échapper<br />// la chaîne "Joe's Widgets"<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">// Exécute la même requête préparée, cette fois avec un paramètre différent<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">"Vêtements Vêtements Vêtements"</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">Voir aussi</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> - Ex&eacute;cute une requ&ecirc;te pr&eacute;par&eacute;e PostGreSQL</span></li>
    <li><span class="function"><a href="function.pg-send-execute.php" class="function" rel="rdfs-seeAlso">pg_send_execute()</a> - Envoie une requ&ecirc;te pour ex&eacute;cuter une requ&ecirc;te pr&eacute;par&eacute;e avec des param&egrave;tres
   donn&eacute;s, sans attendre le(s) r&eacute;sultat(s)</span></li>
   </ul>
  </p>
 </div>

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