php-doc-en/reference/pdo/functions/PDO-query.xml
2005-10-19 20:45:02 +00:00

134 lines
3.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDO-query">
<refnamediv>
<refname>PDO::query</refname>
<refpurpose>
Executes an SQL statement, returning a result set as a PDOStatement object
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>PDOStatement</type><methodname>PDO::query</methodname>
<methodparam><type>string</type><parameter>statement</parameter></methodparam>
</methodsynopsis>
<para>
<function>PDO::query</function> executes an SQL statement in
a single function call, returning the result set (if any) returned by the
statement as a PDOStatement object.
</para>
<para>
For a query that you need to issue multiple times, you will realize better
performance if you prepare a PDOStatement object using
<function>PDO::prepare</function> and issue the statement with multiple
calls to <function>PDOStatement::execute</function>.
</para>
<para>
If you do not fetch all of the data in a result set before issuing your
next call to <function>PDO::query</function>, your call may fail. Call
<function>PDOStatement::closeCursor</function> to release the database
resources associated with the PDOStatement object before issuing your
next call to <function>PDO::query</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>statement</parameter></term>
<listitem>
<para>
The SQL statement to prepare and execute.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>PDO::query</function> returns a PDOStatement object.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Demonstrate PDO::query</title>
<para>
A nice feature of <function>PDO::query</function> is that it
enables you to iterate over the rowset returned by a
successfully executed SELECT statement.
</para>
<programlisting role="php">
<![CDATA[
<?php
function getFruit($conn) {
$sql = 'SELECT name, colour, calories FROM fruit ORDER BY name';
foreach ($conn->query($sql) as $row) {
print $row['NAME'] . "\t";
print $row['COLOUR'] . "\t";
print $row['CALORIES'] . "\n";
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
apple red 150
banana yellow 250
kiwi brown 75
lemon yellow 25
orange orange 300
pear green 150
watermelon pink 90
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PDO::exec</function></member>
<member><function>PDO::prepare</function></member>
<member><function>PDOStatement::execute</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:"../../../../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
-->