1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- 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>
<methodsynopsis>
<type>bool</type><methodname>PDO::query</methodname>
<methodparam><type>string</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>PDO::FETCH_COLUMN</parameter></methodparam>
<methodparam><type>int</type><parameter>colno</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>PDO::query</methodname>
<methodparam><type>string</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>PDO::FETCH_CLASS</parameter></methodparam>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>array</type><parameter>ctorargs</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>PDO::query</methodname>
<methodparam><type>string</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>PDO::FETCH_INTO</parameter></methodparam>
<methodparam><type>object</type><parameter>object</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>
<note>
<para>
Although this function is only documented as having a single
parameter, you may pass additional arguments to this function.
They will be treated as though you called
<function>PDOStatement::setFetchMode</function> on the resultant statement
object.
</para>
</note>
</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
-->
|