ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools


v5:userguide:stored_procedure

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Last revisionBoth sides next revision
userguide:stored_procedure [2015/09/12 17:43] – created mnewnhamv5:userguide:stored_procedure [2018/06/07 09:26] – [Step 2: Setting Parameters] add wrap to highlight requirement to initialize variables; formatting and rewording dregad
Line 28: Line 28:
      
 ==== Creation ==== ==== Creation ====
-The procedure can be created by simply creating a PHP string using the above code, then executing it+The procedure can be created by simply creating a PHP string using the above code, then executing it using ''$db->execute($string)''.
  
 ===== Accessing The Procedure ===== ===== Accessing The Procedure =====
 ==== Step 1: Preparation ==== ==== Step 1: Preparation ====
-The first step is to access the procedure using the [[reference:preparesp|prepareSp()]] method. This method access the procedure and returns a handle, that we will use later. If the procedure name provided is not valid, then the method returns false.+The first step is to access the procedure using the [[v5:reference:connection:preparesp|prepareSp()]] method. This method access the procedure and returns a handle, that we will use later. If the procedure name provided is not valid, then the method returns false.
 <code php> <code php>
 $procedure = $db->prepareSp('PROC_SAMPLE2'); $procedure = $db->prepareSp('PROC_SAMPLE2');
Line 38: Line 38:
     die ('Invalid or inaccessible stored procedure name');     die ('Invalid or inaccessible stored procedure name');
 </code> </code>
-==== Step 2: Setting Parameters ====     +==== Step 2: Setting Parameters ==== 
-Next, the parameters must be set. Stored Procedure Parameters may be either Input,Output or Input-Output parameters. ADOdb provides access to input-output parameters via the outParameter method. The parameter names must match the names of the input/output parameters defined in the stored procedure.+ 
 +Next, the parameters must be set. Stored Procedure Parameters may be either //Input////Output// or //Input-Output// parameters. ADOdb provides access to input-output parameters via the [[v5:reference:connection:outparameter|outParameter()]] method. The parameter names must match those defined in the stored procedure. 
 + 
 +<WRAP right round important> 
 +Because both the parameter names and values are passed by reference, the variables used to hold them must be created and initialized before they are passed on to the methods. 
 +</WRAP> 
 === Input Parameters === === Input Parameters ===
-Because both the parameter names and values are passed by reference, they must be initialized as strings before passing to the methods + 
 <code php>  <code php> 
 /* /*
Line 63: Line 70:
 $ok = $db->inParameter($procedure,'PARAMETER2','ACCOUNT NAME'); $ok = $db->inParameter($procedure,'PARAMETER2','ACCOUNT NAME');
 </code> </code>
 +
 === Output Parameters === === Output Parameters ===
-Output and Input-Output Parameters are passed by reference, the variables used to hold them must be created and initialized before the stored procedure is executed.+
 <code php> <code php>
 $parameter3Name  = 'PARAMETER3'; $parameter3Name  = 'PARAMETER3';
Line 71: Line 79:
 $ok = $db->outParameter($procedure,$parameter3Name,$parameter3Value); $ok = $db->outParameter($procedure,$parameter3Name,$parameter3Value);
 </code> </code>
 +
 ==== Executing The Stored Procedure ==== ==== Executing The Stored Procedure ====
 The stored procedure is executed by passing the handle of the procedure to the execute statement. The stored procedure is executed by passing the handle of the procedure to the execute statement.
v5/userguide/stored_procedure.txt · Last modified: 2019/01/22 01:11 by mnewnham