db2_prepare(3) [php man page]
DB2_PREPARE(3) 1 DB2_PREPARE(3) db2_prepare - Prepares an SQL statement to be executed SYNOPSIS
resource db2_prepare (resource $connection, string $statement, [array $options]) DESCRIPTION
db2_prepare(3) creates a prepared SQL statement which can include 0 or more parameter markers ( ? characters) representing parameters for input, output, or input/output. You can pass parameters to the prepared statement using db2_bind_param(3), or for input values only, as an array passed to db2_execute(3). There are three main advantages to using prepared statements in your application: o Performance: when you prepare a statement, the database server creates an optimized access plan for retrieving data with that statement. Subsequently issuing the prepared statement with db2_execute(3) enables the statements to reuse that access plan and avoids the overhead of dynamically creating a new access plan for every statement you issue. o Security: when you prepare a statement, you can include parameter markers for input values. When you execute a prepared statement with input values for placeholders, the database server checks each input value to ensure that the type matches the column defini- tion or parameter definition. o Advanced functionality: Parameter markers not only enable you to pass input values to prepared SQL statements, they also enable you to retrieve OUT and INOUT parameters from stored procedures using db2_bind_param(3). PARAMETERS
o $connection - A valid database connection resource variable as returned from db2_connect(3) or db2_pconnect(3). o $statement - An SQL statement, optionally containing one or more parameter markers.. o $options - An associative array containing statement options. You can use this parameter to request a scrollable cursor on database servers that support this functionality. For a description of valid statement options, see db2_set_option(3). RETURN VALUES
Returns a statement resource if the SQL statement was successfully parsed and prepared by the database server. Returns FALSE if the data- base server returned an error. You can determine which error was returned by calling db2_stmt_error(3) or db2_stmt_errormsg(3). EXAMPLES
Example #1 Preparing and executing an SQL statement with parameter markers The following example prepares an INSERT statement that accepts four parameter markers, then iterates over an array of arrays con- taining the input values to be passed to db2_execute(3). <?php $animals = array( array(0, 'cat', 'Pook', 3.2), array(1, 'dog', 'Peaches', 12.3), array(2, 'horse', 'Smarty', 350.0), ); $insert = 'INSERT INTO animals (id, breed, name, weight) VALUES (?, ?, ?, ?)'; $stmt = db2_prepare($conn, $insert); if ($stmt) { foreach ($animals as $animal) { $result = db2_execute($stmt, $animal); } } ?> SEE ALSO
db2_bind_param(3), db2_execute(3), db2_stmt_error(3), db2_stmt_errormsg(3). PHP Documentation Group DB2_PREPARE(3)
Check Out this Related Man Page
DB2_EXECUTE(3) 1 DB2_EXECUTE(3) db2_execute - Executes a prepared SQL statement SYNOPSIS
bool db2_execute (resource $stmt, [array $parameters]) DESCRIPTION
db2_execute(3) executes an SQL statement that was prepared by db2_prepare(3). If the SQL statement returns a result set, for example, a SELECT statement or a CALL to a stored procedure that returns one or more result sets, you can retrieve a row as an array from the stmt resource using db2_fetch_assoc(3), db2_fetch_both(3), or db2_fetch_array(3). Alter- natively, you can use db2_fetch_row(3) to move the result set pointer to the next row and fetch a column at a time from that row with db2_result(3). Refer to db2_prepare(3) for a brief discussion of the advantages of using db2_prepare(3) and db2_execute(3) rather than db2_exec(3). PARAMETERS
o $stmt - A prepared statement returned from db2_prepare(3). o $parameters - An array of input parameters matching any parameter markers contained in the prepared statement. RETURN VALUES
Returns TRUE on success or FALSE on failure. EXAMPLES
Example #1 Preparing and executing an SQL statement with parameter markers The following example prepares an INSERT statement that accepts four parameter markers, then iterates over an array of arrays con- taining the input values to be passed to db2_execute(3). <?php $pet = array(0, 'cat', 'Pook', 3.2); $insert = 'INSERT INTO animals (id, breed, name, weight) VALUES (?, ?, ?, ?)'; $stmt = db2_prepare($conn, $insert); if ($stmt) { $result = db2_execute($stmt, $pet); if ($result) { print "Successfully added new pet."; } } ?> The above example will output: Successfully added new pet. Example #2 Calling a stored procedure with an OUT parameter The following example prepares a CALL statement that accepts one parameter marker representing an OUT parameter, binds the PHP variable $my_pets to the parameter using db2_bind_param(3), then issues db2_execute(3) to execute the CALL statement. After the CALL to the stored procedure has been made, the value of $num_pets changes to reflect the value returned by the stored procedure for that OUT parameter. <?php $num_pets = 0; $res = db2_prepare($conn, "CALL count_my_pets(?)"); $rc = db2_bind_param($res, 1, "num_pets", DB2_PARAM_OUT); $rc = db2_execute($res); print "I have $num_pets pets!"; ?> The above example will output: I have 7 pets! Example #3 Returning XML data as an SQL ResultSet The following example demonstrates how to work with documents stored in a XML column using the SAMPLE database. Using some pretty simple SQL/XML, this example returns some of the nodes in a XML document in an SQL ResultSet format that most users are familiar with. <?php $conn = db2_connect("SAMPLE", "db2inst1", "ibmdb2"); $query = 'SELECT * FROM XMLTABLE( XMLNAMESPACES (DEFAULT 'http://posample.org'), 'db2-fn:xmlcolumn("CUSTOMER.INFO")/customerinfo' COLUMNS "CID" VARCHAR (50) PATH '@Cid', "NAME" VARCHAR (50) PATH 'name', "PHONE" VARCHAR (50) PATH 'phone [ @type = "work"]' ) AS T WHERE NAME = ? '; $stmt = db2_prepare($conn, $query); $name = 'Kathy Smith'; if ($stmt) { db2_bind_param($stmt, 1, "name", DB2_PARAM_IN); db2_execute($stmt); while($row = db2_fetch_object($stmt)){ printf("$row->CID $row->NAME $row->PHONE "); } } db2_close($conn); ?> The above example will output: 1000 Kathy Smith 416-555-1358 1001 Kathy Smith 905-555-7258 Example #4 Performing a "JOIN" with XML data The following example works with documents stored in 2 different XML columns in the SAMPLE database. It creates 2 temporary tables from the XML documents from 2 different columns and returns an SQL ResultSet with information regarding shipping status for the cus- tomer. <?php $conn = db2_connect("SAMPLE", "db2inst1", "ibmdb2"); $query = ' SELECT A.CID, A.NAME, A.PHONE, C.PONUM, C.STATUS FROM XMLTABLE( XMLNAMESPACES (DEFAULT 'http://posample.org'), 'db2-fn:xmlcolumn("CUSTOMER.INFO")/customerinfo' COLUMNS "CID" BIGINT PATH '@Cid', "NAME" VARCHAR (50) PATH 'name', "PHONE" VARCHAR (50) PATH 'phone [ @type = "work"]' ) as A, PURCHASEORDER AS B, XMLTABLE ( XMLNAMESPACES (DEFAULT 'http://posample.org'), 'db2-fn:xmlcolumn("PURCHASEORDER.PORDER")/PurchaseOrder' COLUMNS "PONUM" BIGINT PATH '@PoNum', "STATUS" VARCHAR (50) PATH '@Status' ) as C WHERE A.CID = B.CUSTID AND B.POID = C.PONUM AND A.NAME = ? $stmt = db2_prepare($conn, $query); $name = 'Kathy Smith'; if ($stmt) { db2_bind_param($stmt, 1, "name", DB2_PARAM_IN); db2_execute($stmt); while($row = db2_fetch_object($stmt)){ printf("$row->CID $row->NAME $row->PHONE $row->PONUM $row->STATUS "); } } db2_close($conn); ?> The above example will output: 1001 Kathy Smith 905-555-7258 5002 Shipped Example #5 Returning SQL data as part of a larger XML document The following example works with a portion of the PRODUCT.DESCRIPTION documents in the SAMPLE database. It creates a XML document containing product description (XML data) and pricing info (SQL data). <?php $conn = db2_connect("SAMPLE", "db2inst1", "ibmdb2"); $query = ' SELECT XMLSERIALIZE( XMLQUERY(' declare boundary-space strip; declare default element namespace "http://posample.org"; <promoList> { for $prod in $doc/product where $prod/description/price < 10.00 order by $prod/description/price ascending return( <promoitem> { $prod, <startdate> {$start} </startdate>, <enddate> {$end} </enddate>, <promoprice> {$promo} </promoprice> } </promoitem> ) } </promoList> ' passing by ref DESCRIPTION AS "doc", PROMOSTART as "start", PROMOEND as "end", PROMOPRICE as "promo" RETURNING SEQUENCE) AS CLOB (32000)) AS NEW_PRODUCT_INFO FROM PRODUCT WHERE PID = ? $stmt = db2_prepare($conn, $query); $pid = "100-100-01"; if ($stmt) { db2_bind_param($stmt, 1, "pid", DB2_PARAM_IN); db2_execute($stmt); while($row = db2_fetch_array($stmt)){ printf("$row[0] "); } } db2_close($conn); ?> The above example will output: <promoList xmlns="http://posample.org"> <promoitem> <product pid="100-100-01"> <description> <name>Snow Shovel, Basic 22 inch</name> <details>Basic Snow Shovel, 22 inches wide, straight handle with D-Grip</details> <price>9.99</price> <weight>1 kg</weight> </description> </product> <startdate>2004-11-19</startdate> <enddate>2004-12-19</enddate> <promoprice>7.25</promoprice> </promoitem> </promoList> SEE ALSO
db2_exec(3), db2_fetch_array(3), db2_fetch_assoc(3), db2_fetch_both(3), db2_fetch_row(3), db2_prepare(3), db2_result(3). PHP Documentation Group DB2_EXECUTE(3)