<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Prepares a query for execution</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlsrv-num-rows.html">sqlsrv_num_rows</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlsrv-query.html">sqlsrv_query</a></div>
<div class="up"><a href="ref.sqlsrv.html">SQLSRV Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.sqlsrv-prepare" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlsrv_prepare</h1>
<p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">sqlsrv_prepare</span> — <span class="dc-title">Prepares a query for execution</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.sqlsrv-prepare-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>sqlsrv_prepare</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$conn</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sql</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$params</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
]] )</div>
<p class="para rdfs-comment">
Prepares a query for execution. This function is ideal for preparing a query
that will be executed multiple times with different parameter values.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.sqlsrv-prepare-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">conn</code></em></span>
<dd>
<p class="para">
A connection resource returned by <span class="function"><a href="function.sqlsrv-connect.html" class="function">sqlsrv_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">sql</code></em></span>
<dd>
<p class="para">
The string that defines the query to be prepared and executed.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">params</code></em></span>
<dd>
<p class="para">
An array specifying parameter information when executing a parameterized
query. Array elements can be any of the following:
<ul class="simplelist">
<li class="member">A literal value</li>
<li class="member">A PHP variable</li>
<li class="member">An array with this structure:
array($value [, $direction [, $phpType [, $sqlType]]])</li>
</ul>
The following table describes the elements in the array structure above:
</p>
<table class="doctable table">
<caption><strong>Array structure</strong></caption>
<thead>
<tr>
<th>Element</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>$value</td>
<td>A literal value, a PHP variable, or a PHP by-reference variable.</td>
</tr>
<tr>
<td>$direction (optional)</td>
<td>One of the following SQLSRV constants used to indicate the
parameter direction: SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT.
The default value is SQLSRV_PARAM_IN. </td>
</tr>
<tr>
<td>$phpType (optional)</td>
<td>A SQLSRV_PHPTYPE_* constant that specifies PHP data type of the
returned value.</td>
</tr>
<tr>
<td>$sqlType (optional)</td>
<td>A SQLSRV_SQLTYPE_* constant that specifies the SQL Server data
type of the input value.</td>
</tr>
</tbody>
</table>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
An array specifing query property options. The supported keys are described
in the following table:
</p>
<table class="doctable table">
<caption><strong>Query Options</strong></caption>
<thead>
<tr>
<th>Key</th>
<th>Values</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>QueryTimeout</td>
<td>A positive integer value.</td>
<td>Sets the query timeout in seconds. By default, the driver will
wait indefinitely for results.</td>
</tr>
<tr>
<td>SendStreamParamsAtExec</td>
<td><strong><code>TRUE</code></strong> or <strong><code>FALSE</code></strong> (the default is <strong><code>TRUE</code></strong>)</td>
<td>Configures the driver to send all stream data at execution (<strong><code>TRUE</code></strong>),
or to send stream data in chunks (<strong><code>FALSE</code></strong>). By default, the value is set to <strong><code>TRUE</code></strong>.
For more information, see <span class="function"><a href="function.sqlsrv-send-stream-data.html" class="function">sqlsrv_send_stream_data()</a></span>.</td>
</tr>
<tr>
<td>Scrollable</td>
<td>SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC,
or SQLSRV_CURSOR_KEYSET</td>
<td>See <a href="http://msdn.microsoft.com/en-us/library/ee376927.aspx" class="link external">» Specifying a Cursor Type and Selecting Rows</a>
in the Microsoft SQLSRV documentation.</td>
</tr>
</tbody>
</table>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.sqlsrv-prepare-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a statement resource on success and <strong><code>FALSE</code></strong> if an error occurred.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.sqlsrv-prepare-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2188">
<p><strong>Example #1 <span class="function"><strong>sqlsrv_prepare()</strong></span> example</strong></p>
<div class="example-contents"><p>
This example demonstrates how to prepare a statement with <span class="function"><strong>sqlsrv_prepare()</strong></span>
and re-execute it multiple times (with different parameter values) using <span class="function"><a href="function.sqlsrv-execute.html" class="function">sqlsrv_execute()</a></span>.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$serverName </span><span style="color: #007700">= </span><span style="color: #DD0000">"serverName\sqlexpress"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$connectionInfo </span><span style="color: #007700">= array( </span><span style="color: #DD0000">"Database"</span><span style="color: #007700">=></span><span style="color: #DD0000">"dbName"</span><span style="color: #007700">, </span><span style="color: #DD0000">"UID"</span><span style="color: #007700">=></span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"PWD"</span><span style="color: #007700">=></span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_connect</span><span style="color: #007700">( </span><span style="color: #0000BB">$serverName</span><span style="color: #007700">, </span><span style="color: #0000BB">$connectionInfo</span><span style="color: #007700">);<br />if( </span><span style="color: #0000BB">$conn </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> die( </span><span style="color: #0000BB">print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"UPDATE Table_1<br /> SET OrderQty = ?<br /> WHERE SalesOrderID = ?"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Initialize parameters and prepare the statement. <br />// Variables $qty and $id are bound to the statement, $stmt.<br /></span><span style="color: #0000BB">$qty </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$id </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_prepare</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">, array( &</span><span style="color: #0000BB">$qty</span><span style="color: #007700">, &</span><span style="color: #0000BB">$id</span><span style="color: #007700">));<br />if( !</span><span style="color: #0000BB">$stmt </span><span style="color: #007700">) {<br /> die( </span><span style="color: #0000BB">print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #FF8000">// Set up the SalesOrderDetailID and OrderQty information. <br />// This array maps the order ID to order quantity in key=>value pairs.<br /></span><span style="color: #0000BB">$orders </span><span style="color: #007700">= array( </span><span style="color: #0000BB">1</span><span style="color: #007700">=></span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">=></span><span style="color: #0000BB">20</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">=></span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Execute the statement for each order.<br /></span><span style="color: #007700">foreach( </span><span style="color: #0000BB">$orders </span><span style="color: #007700">as </span><span style="color: #0000BB">$id </span><span style="color: #007700">=> </span><span style="color: #0000BB">$qty</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Because $id and $qty are bound to $stmt1, their updated<br /> // values are used with each execution of the statement. <br /> </span><span style="color: #007700">if( </span><span style="color: #0000BB">sqlsrv_execute</span><span style="color: #007700">( </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">) === </span><span style="color: #0000BB">false </span><span style="color: #007700">) {<br /> die( </span><span style="color: #0000BB">print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.sqlsrv-prepare-notes">
<h3 class="title">Notes</h3>
<p class="para">
When you prepare a statement that uses variables as parameters, the variables
are bound to the statement. This means that if you update the values of the
variables, the next time you execute the statement it will run with updated
parameter values. For statements that you plan to execute only once, use
<span class="function"><a href="function.sqlsrv-query.html" class="function">sqlsrv_query()</a></span>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.sqlsrv-prepare-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.sqlsrv-execute.html" class="function" rel="rdfs-seeAlso">sqlsrv_execute()</a> - Executes a statement prepared with sqlsrv_prepare</span></li>
<li class="member"> <span class="function"><a href="function.sqlsrv-query.html" class="function" rel="rdfs-seeAlso">sqlsrv_query()</a> - Prepares and executes a query.</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlsrv-num-rows.html">sqlsrv_num_rows</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlsrv-query.html">sqlsrv_query</a></div>
<div class="up"><a href="ref.sqlsrv.html">SQLSRV Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
