array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.odbc-prepare.php', 1 => 'odbc_prepare', 2 => 'Prepares a statement for execution', ), 'up' => array ( 0 => 'ref.uodbc.php', 1 => 'ODBC Functions', ), 'prev' => array ( 0 => 'function.odbc-pconnect.php', 1 => 'odbc_pconnect', ), 'next' => array ( 0 => 'function.odbc-primarykeys.php', 1 => 'odbc_primarykeys', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/uodbc/functions/odbc-prepare.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

odbc_prepare

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_prepare — Prepares a statement for execution

Description

odbc_prepare(Odbc\Connection $odbc, string $query): Odbc\Result|false

Prepares a statement for execution. The ODBC result object can be used later to execute the statement with odbc_execute().

Some databases (such as IBM DB2, MS SQL Server, and Oracle) support stored procedures that accept parameters of type IN, INOUT, and OUT as defined by the ODBC specification. However, the Unified ODBC driver currently only supports parameters of type IN to stored procedures.

Parameters

odbc

The ODBC connection object, see odbc_connect() for details.

query

The query string statement being prepared.

Return Values

Returns an ODBC result object if the SQL command was prepared successfully. Returns false on error.

Changelog

Version Description
8.4.0 odbc expects an Odbc\Connection instance now; previously, a resource was expected.
8.4.0 This function returns an Odbc\Result instance now; previously, a resource was returned.

Examples

Example #1 odbc_execute() and odbc_prepare() example

In the following code, $success will only be true if all three parameters to myproc are IN parameters:

<?php
$a = 1;
$b = 2;
$c = 3;
$stmt = odbc_prepare($conn, 'CALL myproc(?,?,?)');
$success = odbc_execute($stmt, array($a, $b, $c));
?>

If you need to call a stored procedure using INOUT or OUT parameters, the recommended workaround is to use a native extension for your database (for example, oci8 for Oracle).

See Also