PDO::query

(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.2.0)

PDO::query — プレースホルダを指定せずに、SQL ステートメントを準備して実行する

説明

public PDO::query(string $query, ?int $fetchMode = null): PDOStatement|false

public PDO::query(string $query, ?int $fetchMode = PDO::FETCH_COLUMN, int $colno): PDOStatement|false

public PDO::query(
    string $query,
    ?int $fetchMode = PDO::FETCH_CLASS,
    string $classname,
    array $constructorArgs
): PDOStatement|false

public PDO::query(string $query, ?int $fetchMode = PDO::FETCH_INTO, object $object): PDOStatement|false

PDO::query() は、一回の関数コールの中で SQL ステートメントを準備して実行し、結果を PDOStatement オブジェクトとして返します。

複数回発行する必要があるステートメントの場合、 PDO::prepare() で PDOStatement ステートメントを準備し、 PDOStatement::execute() でそのステートメントを複数回発行する方がより良いパフォーマンスを得られると実感するでしょう。

PDO::query() を次にコールする前に結果セット内の全てのデータを取得しない場合、そのコールは失敗します。 PDOStatement::closeCursor() をコールし、次に PDO::query() をコールする前に PDOStatement オブジェクトに関連付けられたリソースを解放してください。

注意:
query にプレースホルダーが含まれている場合、準備と実行は別々に行う必要があります。つまり、PDO::prepare() を使って準備し、 PDOStatement::execute() を実行しなければいけません。

パラメータ

query

準備、発行する SQL ステートメント。

SQL にプレースホルダーが含まれている場合、 PDO::prepare() と PDOStatement::execute() を代わりに使う必要があります。それとは別のやり方として、 PDO::query() を呼び出す前に、 PDO::quote() を使って適切にフォーマットしたデータを使って SQL文を手動で準備することができます。但し、PDO::quote() は、ドライバがサポートしている場合に限り使えます。

fetchMode

返される PDOStatement のためのデフォルトのフェッチモード。定数 PDO::FETCH_* のうちのひとつを設定しなければいけません。

この引数を渡すと、残りの引数は、結果のステートメントオブジェクトに対して、 PDOStatement::setFetchMode() を呼び出したのと同じような扱いになります。残りの引数は、選択するフェッチモードに応じて変化します。

戻り値

PDOStatement オブジェクトを返します。失敗した場合に false を返します

エラー / 例外

PDO::ATTR_ERRMODE が PDO::ERRMODE_WARNING に設定されていた場合、E_WARNING レベルのエラーが発生します。

PDO::ATTR_ERRMODE が PDO::ERRMODE_EXCEPTION に設定されていた場合、PDOException がスローされます。

例

例1 プレースホルダーがないSQLを、PDO::query() で実行できます

<?php
$sql = 'SELECT name, color, calories FROM fruit ORDER BY name';
foreach ($conn->query($sql) as $row) {
    print $row['name'] . "\t";
    print $row['color'] . "\t";
    print $row['calories'] . "\n";
}
?>

上の例の出力は以下となります。

apple   red     150
banana  yellow  250
kiwi    brown   75
lemon   yellow  25
orange  orange  300
pear    green   150
watermelon      pink    90

参考

PDO::exec() - SQL ステートメントを実行し、作用した行数を返す
PDO::prepare() - 文を実行する準備を行い、文オブジェクトを返す
PDOStatement::execute() - プリペアドステートメントを実行する