Files
Leonardo Lara Rodrigues 21d5801f13 sync with en rev
2026-03-10 15:33:06 -03:00

162 lines
5.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5f1a92089fa4efe81e9777f87f9ed93f4853898b Maintainer: fernandowobeto Status: ready --><!-- CREDITS: fernandowobeto -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry xml:id="function.pg-execute" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_execute</refname>
<refpurpose>Envia uma solicitação para executar uma instrução preparada com determinados parâmetros e aguarda o resultado</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_execute</methodname>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>stmtname</parameter></methodparam>
<methodparam><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>
Envia uma solicitação para executar uma instrução preparada com determinados parâmetros e
aguarda o resultado.
</para>
<para>
<function>pg_execute</function> é como <function>pg_query_params</function>,
mas o comando a ser executado é
especificado nomeando uma instrução previamente preparada, em vez de fornecer uma
string de consulta. 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.
A declaração deve ter sido preparada anteriormente na sessão atual.
</para>
<para>
Os parâmetros são idênticos a <function>pg_query_params</function>, exceto que o nome de uma
instrução preparada é fornecido em vez de uma string de consulta.
</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>stmtname</parameter></term>
<listitem>
<para>
O nome da instrução preparada a ser executada. se
"" for especificado, a instrução sem nome será executada. O nome deve ter
sido preparado previamente usando <function>pg_prepare</function>,
<function>pg_send_prepare</function> ou um comando SQL
<literal>PREPARE</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<listitem>
<para>
Um array de valores de parâmetros para substituir os espaços reservados $1, $2, etc.
na string de consulta preparada original. O número de elementos no array
deve corresponder ao número de espaços reservados.
</para>
<warning>
<para>
Os elementos são convertidos em strings chamando esta função.
</para>
</warning>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Uma instância <classname>PgSql\Result</classname> em caso de sucesso, &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>Usando <function>pg_execute</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Conecta com um banco de dados chamado "mary"
$dbconn = pg_connect("dbname=mary");
// Prepara a consulta para execução
$result = pg_prepare($dbconn, "my_query", 'SELECT * FROM shops WHERE name = $1');
// Executa a consulta preparada. Observe que não é necessário escapar a
// string "Joe's Widgets" de forma alguma
$result = pg_execute($dbconn, "my_query", array("Joe's Widgets"));
// Execute a mesma consulta preparada, desta vez com um parâmetro diferente
$result = pg_execute($dbconn, "my_query", array("Clothes Clothes Clothes"));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pg_prepare</function></member>
<member><function>pg_send_prepare</function></member>
<member><function>pg_query_params</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
-->