oci_fetch_all
oci_fetch_assoc
OCI8 関数
PHP Manual

# oci_fetch_array

(PHP 5, PECL OCI8 >= 1.1.0)

oci_fetch_array — クエリの次の行を連想配列あるいは数値添字配列で返す

### 説明

array oci_fetch_array ( resource `$statement` [, int `$mode` ] )

クエリから、結果セットの次の行を含む配列を返します。 配列の各エントリが行の各カラムをあらわします。 この関数の典型的な使い方は、ループの中で `FALSE` を返すまでコールすることです。 `FALSE` は、もう行がないことを意味します。

OCI8 拡張モジュールによるデータ型マッピングの 詳細については、ドライバが サポートするデータ型 を参照ください。

### パラメータ

`statement`

  oci_parse() で作成して oci_execute() で実行した有効な OCI8 ステートメント ID、 あるいは REF CURSOR ステートメント ID。

`mode`

  オプションの第2引数は、次の定数の組み合わせが可能です。

  oci_fetch_array() のモード
  定数 | 説明
  --- | ---
  `OCI_BOTH` | 連想配列と配列の両方を返します。 これは `OCI_ASSOC` + `OCI_NUM` と同等で、 デフォルトの動作です。
  `OCI_ASSOC` | 連想配列を返します。
  `OCI_NUM` | 数値添字配列を返します。
  `OCI_RETURN_NULLS` | `NULL` フィールドの要素も作成します。この要素の値は PHP の `NULL` となります。
  `OCI_RETURN_LOBS` | LOB ディスクリプタではなく LOB の中身を返します。

  デフォルトの `mode` は `OCI_BOTH` です。

  加算演算子 "+" を使うと、複数のモードを動じに指定できます。

### 返り値

連想配列や数値添字配列を返します。 `statement` にもう行がない場合は `FALSE` を返します。

デフォルトでは、LOB カラムは LOB ディスクリプタを返します。

DATE カラムは、現行のデータフォーマットにフォーマットされた 文字列として返されます。既定のフォーマットは NLS_LANG のような Oracle 環境変数で変更したり、またはあらかじめ ALTER SESSION SET NLS_DATE_FORMAT コマンドを実行して変更します。

Oracle のデフォルトでは、大文字小文字を区別しないカラム名はすべて大文字となり、 結果の連想配列のインデックスも大文字になります。 大文字小文字を区別するカラム名は、配列のインデックスもそれと同じになります。 結果の配列を var_dump() すれば、 各クエリの大文字小文字を確かめることができます。

### 例

例1 oci_fetch_array() での `OCI_BOTH` の使用例

`<?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 department_id, department_name FROM departments');
oci_execute($stid);
while (($row = oci_fetch_array($stid, OCI_BOTH))) {
// 連想配列の指標として大文字のカラム名を使用します
echo $row[0] . " and " . $row['DEPARTMENT_ID'] . " are the same<br>\n";
echo $row[1] . " and " . $row['DEPARTMENT_NAME'] . " are the same<br>\n";
}
oci_free_statement($stid);
oci_close($conn);
?>`

例2 oci_fetch_array() での `OCI_NUM` の使用例

`<?php
/*
実行する前にテーブルを作成します。
CREATE TABLE mytab (id NUMBER, description CLOB);
INSERT INTO mytab (id, description) values (1, 'A very long string');
COMMIT;
*/
$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 id, description FROM mytab');
oci_execute($stid);
while (($row = oci_fetch_array($stid, OCI_NUM))) {
echo $row[0] . "<br>\n";
echo $row[1]->read(11) . "<br>\n"; // DESCRIPTION から最初の 11 バイトを出力します
}
// 出力です。
// 1
// A very long
oci_free_statement($stid);
oci_close($conn);
?>`

例3 oci_fetch_array() での `OCI_ASSOC` の使用例

`<?php
/*
実行する前にテーブルを作成します。
CREATE TABLE mytab (id NUMBER, description CLOB);
INSERT INTO mytab (id, description) values (1, 'A very long string');
COMMIT;
*/
$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 id, description FROM mytab');
oci_execute($stid);
while (($row = oci_fetch_array($stid, OCI_ASSOC))) {
echo $row['ID'] . "<br>\n";
echo $row['DESCRIPTION']->read(11) . "<br>\n"; // DESCRIPTION から最初の 11 バイトを出力します
}
// 出力です。
// 1
// A very long
oci_free_statement($stid);
oci_close($conn);
?>`

例4 oci_fetch_array() での `OCI_RETURN_NULLS` の使用例

`<?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 1, null FROM dual');
oci_execute($stid);
while (($row = oci_fetch_array ($stid, OCI_ASSOC))) { // NULL を無視
var_dump($row);
}
/*
上記のコードの出力です。
array(1) {
[1]=>
string(1) "1"
}
*/
$stid = oci_parse($conn, 'SELECT 1, null FROM dual');
oci_execute($stid);
while (($row = oci_fetch_array ($stid, OCI_ASSOC+OCI_RETURN_NULLS))) { // NULL をフェッチ
var_dump($row);
}
/*
上記のコードの出力です。
array(2) {
[1]=>
string(1) "1"
["NULL"]=>
NULL
}
*/
?>`

例5 oci_fetch_array() での `OCI_RETURN_LOBS` の使用例

`<?php
/*
実行する前にテーブルを作成します。
CREATE TABLE mytab (id NUMBER, description CLOB);
INSERT INTO mytab (id, description) values (1, 'A very long string');
COMMIT;
*/
$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 id, description FROM mytab');
oci_execute($stid);
while (($row = oci_fetch_array($stid, OCI_ASSOC+OCI_RETURN_LOBS))) {
echo $row['ID'] . "<br>\n";
echo $row['DESCRIPTION'] . "<br>\n"; // DESCRIPTION の全てが含まれます
}
// 出力です。
// 1
// A very long string
oci_free_statement($stid);
oci_close($conn);
?>`

例6 oci_fetch_array() での文字の大小を区別するカラムの使用例

`<?php
/*
実行する前にテーブルを作成します。
CREATE TABLE mytab ("Name" VARCHAR2(20), city VARCHAR2(20));
INSERT INTO mytab ("Name", city) values ('Chris', 'Melbourne');
COMMIT;
*/
$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 * from mytab');
oci_execute($stid);
$row = oci_fetch_array($stid, OCI_ASSOC+OCI_RETURN_NULLS);
// 'Name' は文字の大小を区別するカラムとして作成されたので、配列の指標として
// 同一のケースを使用します。しかしながら、文字の大小を区別しないカラムの
// 指標としては、大文字の 'CITY' を使わなければいけません。
print $row['Name'] . "<br>\n"; // Chris を出力
print $row['CITY'] . "<br>\n"; // Melbourne を出力
oci_free_statement($stid);
oci_close($conn);
?>`

例7 oci_fetch_array() での同じ名前のカラムの使用例

`<?php
/*
実行する前にテーブルを作成します。
CREATE TABLE mycity (id NUMBER, name VARCHAR2(20));
INSERT INTO mycity (id, name) values (1, 'Melbourne');
CREATE TABLE mycountry (id NUMBER, name VARCHAR2(20));
INSERT INTO mycountry (id, name) values (1, 'Australia');
COMMIT;
*/
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
$e = oci_error();
trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}
$sql = 'SELECT mycity.name, mycountry.name
FROM mycity, mycountry
WHERE mycity.id = mycountry.id';
$stid = oci_parse($conn, $sql);
oci_execute($stid);
$row = oci_fetch_array($stid, OCI_ASSOC);
var_dump($row);
// 出力には "NAME" 項目一つだけが含まれます。
// array(1) {
// ["NAME"]=>
// string(9) "Australia"
// }
// 度重なるカラム名を照会するには、 "AS ctnm" のような SQL カラムのエイリアスを使います。
$sql = 'SELECT mycity.name AS ctnm, mycountry.name
FROM mycity, mycountry
WHERE mycity.id = mycountry.id';
$stid = oci_parse($conn, $sql);
oci_execute($stid);
$row = oci_fetch_array($stid, OCI_ASSOC);
var_dump($row);
// これで出力には選択したカラムが両方含まれます。
// array(2) {
// ["CTNM"]=>
// string(9) "Melbourne"
// ["NAME"]=>
// string(9) "Australia"
// }
oci_free_statement($stid);
oci_close($conn);
?>`

例8 oci_fetch_array() での DATE カラムの使用例

`<?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, "ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD'");
oci_execute($stid);
$stid = oci_parse($conn, 'SELECT hire_date FROM employees WHERE employee_id = 188');
oci_execute($stid);
$row = oci_fetch_array($stid, OCI_ASSOC);
echo $row['HIRE_DATE'] . "<br>\n"; // 1997-06-14 を出力
oci_free_statement($stid);
oci_close($conn);
?>`

例9 oci_fetch_array() での REF CURSOR の使用例

`<?php
/*
下記のようにして PL/SQL ストアド・プロシジャーを作成します。
CREATE OR REPLACE PROCEDURE myproc(p1 OUT SYS_REFCURSOR) AS
BEGIN
OPEN p1 FOR SELECT * FROM all_objects WHERE ROWNUM < 5000;
END;
*/
$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, 'BEGIN myproc(:rc); END;');
$refcur = oci_new_cursor($conn);
oci_bind_by_name($stid, ':rc', $refcur, -1, OCI_B_CURSOR);
oci_execute($stid);
// 返された REF CURSOR を実行して、ステートメント識別子のようにそこからフェッチします
oci_execute($refcur);
echo "<table border='1'>\n";
while ($row = oci_fetch_array($refcur, OCI_ASSOC+OCI_RETURN_NULLS)) {
echo "<tr>\n";
foreach ($row as $item) {
echo " <td>".($item !== null ? htmlentities($item, ENT_QUOTES) : "&nbsp;")."</td>\n";
}
echo "</tr>\n";
}
echo "</table>\n";
oci_free_statement($refcur);
oci_free_statement($stid);
oci_close($conn);
?>`

例10 oci_fetch_array() での LIMIT 風のクエリの使用例

`<?php
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
$e = oci_error();
trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}
// これが実行したいクエリーです
$sql = 'SELECT city, postal_code FROM locations ORDER BY city';
// このネストしたクエリーにより、 $sql から行のサブセットが選択されます。
// 製品環境では、連結した SQL 文による SQL インジェクションの問題を
// 防止するよう気をつけてください
$limit_sql =
'select *
from ( select a.*, rownum as rnum
from (' . $sql . ') a
where rownum < :FIRST_ROW + :NUM_ROWS )
where rnum >= :FIRST_ROW';
$first = 1; // 最初の行で開始
$num = 5; // 5 行を返す
$stid = oci_parse($conn, $limit_sql);
oci_bind_by_name($stid, ':FIRST_ROW', $first);
oci_bind_by_name($stid, ':NUM_ROWS', $num);
oci_execute($stid);
while (($row = oci_fetch_array($stid, OCI_ASSOC))) {
echo $row['CITY'] . " " . $row['POSTAL_CODE'] . "<br>\n";
}
// 出力です。
// Beijing 190518x
// Bern 3095x
// Bombay 490231x
// Geneva 1730x
// Hiroshima 6823x
oci_free_statement($stid);
oci_close($conn);
?>`

### 注意

> 注意: 大文字小文字を区別せずにつくった Oracle のカラムでは、 連想配列のインデックスはすべて大文字となることに注意しましょう。

> 注意: 大量の行を返すクエリの場合、 oci8.default_prefetch を増やすか oci_set_prefetch() を使えばパフォーマンスが劇的に向上します。

> 注意: oci_fetch_array() は ほんの少しだけ oci_fetch_assoc() や oci_fetch_row() より低速ですが、 ずっと柔軟性があります。

### 参考

- oci_fetch() - クエリの次の行を内部バッファに取得する
- oci_fetch_all() - クエリからの複数の行を二次元配列に取得する
- oci_fetch_assoc() - クエリの次の行を連想配列で返す
- oci_fetch_object() - クエリの次の行をオブジェクトとして返す
- oci_fetch_row() - クエリの次の行を配列で返す
- oci_set_prefetch() - クエリがプリフェッチする行数を設定する

oci_fetch_all
oci_fetch_assoc
OCI8 関数
PHP Manual