<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.pg-prepare.php',
    1 => 'pg_prepare',
    2 => 'Envia uma solicita&ccedil;&atilde;o ao servidor para criar uma instru&ccedil;&atilde;o preparada com os
   par&acirc;metros fornecidos e aguarda a conclus&atilde;o',
  ),
  'up' => 
  array (
    0 => 'ref.pgsql.php',
    1 => 'Fun&ccedil;&otilde;es 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' => 'pt_BR',
    '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">
   Envia uma solicitação ao servidor para criar uma instrução preparada com os
   parâmetros fornecidos e aguarda a conclusão
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.pg-prepare-description">
  <h3 class="title">Descrição</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> cria uma instrução preparada para execução posterior com
   <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>.
   Este recurso permite que comandos que serão usados repetidamente
   sejam analisados e planejados apenas uma vez, em vez de cada vez que forem executados.
  </p>
  <p class="para">
   A função cria uma instrução preparada chamada <code class="parameter">stmtname</code> a partir da string <code class="parameter">query</code>,
   que deve conter um único comando SQL. <code class="parameter">stmtname</code> pode ser <code class="literal">&quot;&quot;</code> para
   criar uma instrução sem nome, caso em que qualquer instrução sem nome pré-existente
   é automaticamente substituída; caso contrário, será um erro se o nome da
   instrução já estiver definido na sessão atual. Se algum parâmetro
   for usado, ele será referido na <code class="parameter">query</code> como <code class="literal">$1</code>,
   <code class="literal">$2</code> etc.
  </p>
  <p class="para">
   Instruções preparadas para uso com <span class="function"><strong>pg_prepare()</strong></span> também podem ser criadas
   executando instruções SQL <code class="literal">PREPARE</code>. (Mas <span class="function"><strong>pg_prepare()</strong></span> é
   mais flexível, pois não requer que os tipos de parâmetros sejam pré-especificados.) Além disso,
   embora não exista uma função PHP para excluir uma instrução preparada, a
   declaração SQL <code class="literal">DEALLOCATE</code> pode ser usada para esse propósito.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.pg-prepare-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection</code></dt>
     <dd>
      <p class="para">Uma instância de <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>.
Quando o parâmetro <code class="parameter">connection</code> não for especificado, a conexão padrão será usada.
A conexão padrão é a última conexão feita por <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">Aviso</strong><p class="simpara">A partir do PHP 8.1.0, usar a conexão padrão foi descontinuado.</p></div></p>
     </dd>
    
    
     <dt><code class="parameter">stmtname</code></dt>
     <dd>
      <p class="para">
       O nome para dar a declaração preparada. Deve ser exclusivo por conexão. Se
       <code class="literal">&quot;&quot;</code> for especificado, uma instrução sem nome será criada, substituindo qualquer
       instrução sem nome definida anteriormente.
      </p>
     </dd>
    
    
     <dt><code class="parameter">query</code></dt>
     <dd>
      <p class="para">
       A instrução SQL parametrizada. Deve conter apenas uma única instrução
       (múltiplas instruções separadas por ponto e vírgula não são permitidas). Se algum parâmetro
       for usado, ele será chamado de <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">Valor Retornado</h3>
  <p class="para">
   Uma instância <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span> em caso de sucesso,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.pg-prepare-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  Agora retorna uma instância de <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span>;
  anteriormente, um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> era retornado.
 </td>
</tr>

     <tr>
 <td>8.1.0</td>
 <td>
  O parâmetro <code class="parameter">connection</code> agora espera uma instância de <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>;
  anteriormente, um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> era esperado.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.pg-prepare-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Usando <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">// Conecta a um banco de dados chamado "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">// Prepara uma consulta para execução<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">// Executa a consulta preparada. Observe que não é necessário escapar<br />// a string "Joe's Widgets" de forma alguma<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">// Executa a mesma consulta preparada, desta vez com um parâmetro diferente<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">Veja Também</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> - Envia uma solicita&ccedil;&atilde;o para executar uma instru&ccedil;&atilde;o preparada com determinados par&acirc;metros e aguarda o resultado</span></li>
    <li><span class="function"><a href="function.pg-send-execute.php" class="function" rel="rdfs-seeAlso">pg_send_execute()</a> - Envia uma solicita&ccedil;&atilde;o para executar uma instru&ccedil;&atilde;o preparada com determinados par&acirc;metros, sem esperar pelo(s) resultado(s)</span></li>
   </ul>
  </p>
 </div>

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