OCI_FETCH_ALL(3)														  OCI_FETCH_ALL(3)

oci_fetch_all - Fetches multiple rows from a query into a two-dimensional array

SYNOPSIS

       int  oci_fetch_all  OCI_FETCHSTATEMENT_BY_COLUMN OCI_ASSOC (resource  $statement, array	&$output, [int	$skip], [int  $maxrows = -1], [int
       $flags =  + ])

DESCRIPTION

	Fetches multiple rows from a query into a two-dimensional array. By default, all rows are returned.

	This function can be called only once for each query executed with oci_execute(3).

PARAMETERS

	      o $statement
		-A valid OCI8 statement identifier created by oci_parse(3) and executed by oci_execute(3), or a REF CURSOR statement identifier.

	      o $output
		- The variable to contain the returned rows.  LOB columns  are	returned  as  strings,	where  Oracle  supports  conversion.   See
		oci_fetch_array(3) for more information on how data and types are fetched.

	      o $skip
		- The number of initial rows to discard when fetching the result. The default value is 0, so the first row onwards is returned.

	      o $maxrows
		- The number of rows to return. The default is -1 meaning return all the rows from $skip + 1 onwards.

	      o $flags
		- Parameter $flags indicates the array structure and whether associative arrays should be used.

	      oci_fetch_all(3) Array Structure Modes

	      +-----------------------------+---------------------------------------------------+
	      | 	 Constant	    |							|
	      | 			    |							|
	      | 			    |			 Description			|
	      | 			    |							|
	      +-----------------------------+---------------------------------------------------+
	      | 			    |							|
	      | OCI_FETCHSTATEMENT_BY_ROW   |							|
	      | 			    |							|
	      | 			    | The  outer  array  will contain one sub-array per |
	      | 			    | query row.					|
	      | 			    |							|
	      | 			    |							|
	      |OCI_FETCHSTATEMENT_BY_COLUMN |							|
	      | 			    |							|
	      | 			    | The outer array will contain  one  sub-array  per |
	      | 			    | query column. This is the default.		|
	      | 			    |							|
	      +-----------------------------+---------------------------------------------------+
	       Arrays can be indexed either by column heading or numerically. Only one index mode will be returned.

	      oci_fetch_all(3) Array Index Modes

	      +----------+---------------------------------------------------+
	      |Constant  |						     |
	      | 	 |						     |
	      | 	 |		      Description		     |
	      | 	 |						     |
	      +----------+---------------------------------------------------+
	      | 	 |						     |
	      | OCI_NUM  |						     |
	      | 	 |						     |
	      | 	 | Numeric indexes are used for each column's array. |
	      | 	 |						     |
	      | 	 |						     |
	      |OCI_ASSOC |						     |
	      | 	 |						     |
	      | 	 | Associative	indexes  are  used for each column's |
	      | 	 | array. This is the default.			     |
	      | 	 |						     |
	      +----------+---------------------------------------------------+
	       Use the addition operator "+" to choose a combination of array structure and index modes.   Oracle's  default,  non-case  sensitive
	      column  names  will  have  uppercase  array  keys. Case-sensitive column names will have array keys using the exact column case. Use
	      var_dump(3) on $output to verify the appropriate case to use for each query.  Queries that have more than one column with  the  same
	      name should use column aliases. Otherwise only one of the columns will appear in an associative array.

RETURN VALUES

	Returns the number of rows in $output, which may be 0 or more, or FALSE on failure.

EXAMPLES

       Example #1

	      oci_fetch_all(3) example

	      <?php

	      $conn = oci_connect('hr', 'welcome', 'localhost/XE');
	      if (!$conn) {
		  $e = oci_error();
		  trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
	      }

	      $stid = oci_parse($conn, 'SELECT POSTAL_CODE, CITY FROM locations WHERE ROWNUM < 3');
	      oci_execute($stid);

	      $nrows = oci_fetch_all($stid, $res);

	      echo "$nrows rows fetched<br>
";
	      var_dump($res);

	      // var_dump output is:
	      //    2 rows fetched
	      //    array(2) {
	      //      ["POSTAL_CODE"]=>
	      //      array(2) {
	      //	[0]=>
	      //	string(6) "00989x"
	      //	[1]=>
	      //	string(6) "10934x"
	      //      }
	      //      ["CITY"]=>
	      //      array(2) {
	      //	[0]=>
	      //	string(4) "Roma"
	      //	[1]=>
	      //	string(6) "Venice"
	      //      }
	      //    }

	      // Pretty-print the results
	      echo "<table border='1'>
";
	      foreach ($res as $col) {
		  echo "<tr>
";
		  foreach ($col as $item) {
		      echo "	<td>".($item !== null ? htmlentities($item, ENT_QUOTES) : "")."</td>
";
		  }
		  echo "</tr>
";
	      }
	      echo "</table>
";

	      oci_free_statement($stid);
	      oci_close($conn);

	      ?>

       Example #2

	      oci_fetch_all(3) example with OCI_FETCHSTATEMENT_BY_ROW

	      <?php

	      $conn = oci_connect('hr', 'welcome', 'localhost/XE');
	      if (!$conn) {
		  $e = oci_error();
		  trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
	      }

	      $stid = oci_parse($conn, 'SELECT POSTAL_CODE, CITY FROM locations WHERE ROWNUM < 3');
	      oci_execute($stid);

	      $nrows = oci_fetch_all($stid, $res, null, null, OCI_FETCHSTATEMENT_BY_ROW);

	      echo "$nrows rows fetched<br>
";
	      var_dump($res);

	      // Output is:
	      //    2 rows fetched
	      //    array(2) {
	      //      [0]=>
	      //      array(2) {
	      //	["POSTAL_CODE"]=>
	      //	string(6) "00989x"
	      //	["CITY"]=>
	      //	string(4) "Roma"
	      //      }
	      //      [1]=>
	      //      array(2) {
	      //	["POSTAL_CODE"]=>
	      //	string(6) "10934x"
	      //	["CITY"]=>
	      //	string(6) "Venice"
	      //      }
	      //    }

	      oci_free_statement($stid);
	      oci_close($conn);

	      ?>

       Example #3

	      oci_fetch_all(3) with OCI_NUM

	      <?php

	      $conn = oci_connect('hr', 'welcome', 'localhost/XE');
	      if (!$conn) {
		  $e = oci_error();
		  trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
	      }

	      $stid = oci_parse($conn, 'SELECT POSTAL_CODE, CITY FROM locations WHERE ROWNUM < 3');
	      oci_execute($stid);

	      $nrows = oci_fetch_all($stid, $res, null, null, OCI_FETCHSTATEMENT_BY_ROW + OCI_NUM);

	      echo "$nrows rows fetched<br>
";
	      var_dump($res);

	      // Output is:
	      //    2 rows fetched
	      //    array(2) {
	      //      [0]=>
	      //      array(2) {
	      //	[0]=>
	      //	string(6) "00989x"
	      //	[1]=>
	      //	string(4) "Roma"
	      //      }
	      //      [1]=>
	      //      array(2) {
	      //	[0]=>
	      //	string(6) "10934x"
	      //	[1]=>
	      //	string(6) "Venice"
	      //      }
	      //    }

	      oci_free_statement($stid);
	      oci_close($conn);

	      ?>

NOTES

       Note

	       Using  $skip  is  very inefficient. All the rows to be skipped are included in the result set that is returned from the database to
	      PHP. They are then discarded. It is more efficient to use SQL  to  restrict  the	offset	and  range  of	rows  in  the  query.  See
	      oci_fetch_array(3) for an example.

       Note

	       Queries	that  return a large number of rows can be more memory efficient if a single-row fetching function like oci_fetch_array(3)
	      is used.

       Note

	      For queries returning a large number of rows, performance can be significantly improved by increasing oci8.default_prefetch or using
	      oci_set_prefetch(3).

       Note

	       Will not return rows from Oracle Database 12 c Implicit Result Sets. Use oci_fetch_array(3) instead.

SEE ALSO

       oci_fetch(3), oci_fetch_array(3), oci_fetch_assoc(3), oci_fetch_object(3), oci_fetch_row(3), oci_set_prefetch(3).

PHP Documentation Group 													  OCI_FETCH_ALL(3)