PDO::query

[edit] Last updated: Fri, 10 Feb 2012

PDO::prepare

(PHP 5 >= 5.1.0, PECL pdo >= 0.1.0)

PDO::prepare — 文を実行する準備を行い、文オブジェクトを返す

説明

PDOStatement PDO::prepare ( string $statement [, array $driver_options = array() ] )

PDOStatement::execute() メソッドによって実行される SQL ステートメントを準備します。 SQL ステートメントは、文が実行されるときに実際の値に置き換えられる 0 個もしくはそれ以上の名前 (:name) もしくは疑問符 (?) パラメータマークを含むことができます。名前と疑問符パラメータを同一 SQL ステートメント中で使用することはできません。どちらか一方か、他のパラメータ形式を使用してください。ユーザの入力をバインドする際にはこれらのパラメータを使います。ユーザの入力を直接クエリに含めてはいけません。

PDOStatement::execute() をコールする際には、文に渡すパラメータにはそれぞれ固有のパラメータマークを設定する必要があります。ひとつのプリペアドステートメントの中で、同じ名前のパラメータマークを複数使用することはできません。SQL 文の IN() 句などで、ひとつのパラメータに複数の値を割り当てることはできません。

異なるパラメータを用いて複数回実行されるような文に対し PDO::prepare() と PDOStatement::execute() をコールすることで、ドライバがクライアントまたはサーバ側にクエリプランやメタ情報をキャッシュさせるよう調整するため、アプリケーションのパフォーマンスを最適化します。また、パラメータに手動でクオートする必要がなくなるので SQL インジェクション攻撃から保護する助けになります。

PDO は元々この機能をサポートしていないドライバに対してプリペアドステートメントとバインドパラメータをエミュレートします。このため、ある形式をサポートしているがその他の形式をサポートしていないドライバの場合、名前もしくは疑問符形式のパラメータを他の適当な値に書き換えることも可能です。

パラメータ

statement: これは対象のデータベースサーバに対して有効な SQL 文でなければなりません。
driver_options: この配列は、このメソッドによって返される PDOStatement オブジェクトに対して 1 もしくはそれ以上の key=>value の組を含みます。通常、スクロール可能なカーソルを要求するために PDO::ATTR_CURSOR に PDO::CURSOR_SCROLL を設定する場合に使用することになるでしょう。いくつかのドライバには、準備する際に利用可能なドライバ固有のオプションがあります。

返り値

もしデータベースサーバが正常に文を準備する場合、 PDO::prepare() は PDOStatement オブジェクトを返します。もしデータベースサーバが文を準備できなかった場合、 PDO::prepare() は FALSE を返すか PDOException を発行します (エラー処理の方法に依存します)。

注意:
プリペアドステートメントをエミュレートする際にデータベースサーバとの通信は行いません。したがって PDO::prepare() はステートメントのチェックを行いません。

例

例1 名前付きパラメータを用いて SQL ステートメントを準備する


<?php
/* 値の配列を渡してプリペアドステートメントを実行する */
$sql = 'SELECT name, colour, calories
    FROM fruit
    WHERE calories < :calories AND colour = :colour';
$sth = $dbh->prepare($sql, array(PDO::ATTR_CURSOR => PDO::CURSOR_FWDONLY));
$sth->execute(array(':calories' => 150, ':colour' => 'red'));
$red = $sth->fetchAll();
$sth->execute(array(':calories' => 175, ':colour' => 'yellow'));
$yellow = $sth->fetchAll();
?>

例2 疑問符パラメータを用いて SQL ステートメントを準備する


<?php
/* 値の配列を渡してプリペアドステートメントを実行する */
$sth = $dbh->prepare('SELECT name, colour, calories
    FROM fruit
    WHERE calories < ? AND colour = ?');
$sth->execute(array(150, 'red'));
$red = $sth->fetchAll();
$sth->execute(array(175, 'yellow'));
$yellow = $sth->fetchAll();
?>

参考

PDO::exec() - SQL ステートメントを実行し、作用した行数を返す
PDO::query() - SQL ステートメントを実行し、結果セットを PDOStatement オブジェクトとして返す
PDOStatement::execute() - プリペアドステートメントを実行する

PDO::query

PDO::lastInsertId

[edit] Last updated: Fri, 10 Feb 2012

add a note User Contributed Notes PDO::prepare

webmaster at salientdigital dot com 10-Jun-2011 10:09


Using PDO to do database introspection...



<?php

    // Get a list of tables

    $tables = array();

    $sql = "SHOW TABLES";

    $stm = $this->prepare($sql);

    $result = $stm->execute();

    $columnname = 'Tables_in_'. $config['database'];

    while( $row = $stm->fetchObject() ){

        $tables[] = $row->$columnname;

    }

    print_r($tables);

?>



I just found that it is not possible to prepare "SHOW CREATE TABLE ?" nor "SHOW CREATE TABLE :tablename" however, doing it with string concatenation worked fine:



<?php

    $schemas = array();

    foreach($tables as $table)

    {

        $sql = 'SHOW CREATE TABLE '. $table;

        $stm = $this->prepare($sql);

        $result = $stm->execute();

        $columnname = 'Create Table';

        while( $row = $stm->fetchObject() ){

            $schemas[$table] = $row->$columnname;

        }

    }

    print_r($schemas);

?>

pascal dot buguet at laposte dot net 31-Aug-2010 05:11


PDO::CURSOR_SCROLL is ok with MSS.

You must install SQL Server Driver for PHP 2.0 CTP2 : SQLSRV20.EXE

and  the native client "Microsoft SQL Server 2008 R2 Native Client" : sqlncli.msi.

php at evan dot fribourgonline dot com 17-May-2010 10:53


Note that PDO::CURSOR_SCROLL is **not** supported or emulated by the MySQL PDO driver, nor is a warning thrown.



See: http://bugs.php.net/bug.php?id=44475

Robin 04-Mar-2010 05:01


Use prepared statements to ensure integrity of binary data during storage and retrieval. Escaping/quoting by f.e. sqlite_escape_string() or PDO::quote() is NOT suited for binary data - only for strings of text.



A simple test verifies perfect storage and retrieval with prepared statements:



<?php



$num_values = 10000;



$db = new pdo( 'sqlite::memory:' );



$db->exec( 'CREATE TABLE data (binary BLOB(512));' );



// generate plenty of troublesome, binary data

for( $i = 0; $i < $num_values; $i++ )

{

    for( $val = null, $c = 0; $c < 512/16; $c++ )

        $val .= md5( mt_rand(), true );

    @$binary[] = $val;

}



// insert each value by prepared statement

for( $i = 0; $i < $num_values; $i++ )

    $db->prepare( 'INSERT INTO data VALUES (?);' )->execute( array($binary[$i]) );



// fetch the entire row

$data = $db->query( 'SELECT binary FROM data;' )->fetchAll( PDO::FETCH_COLUMN );



// compare with original array, noting any mismatch

for( $i = 0; $i < $num_values; $i++ )

    if( $data[$i] != $binary[$i] ) echo "[$i] mismatch\n";



$db = null;



?>

sgirard at rossprint dot com 29-Oct-2009 03:15


Maybe everyone else already knows this but...



If you have a routine that prepares/executes many insert or update statements for a sqlite db then you may want to make use of the pdo transactions. 



On some old hardware my query set went from 12 seconds to 1/3-1/2 second. 



-sean

richard at codevanilla.com 11-Sep-2009 04:44


beware


PDO will emulate prepared statements/bound parameters for drivers that do not natively support them, and can also rewrite named or question mark style parameter markers to something more appropriate, if the driver supports one style but not the other.





This includes mySQL it seems so





<?php


try{ 


        $sth1 = $this->db1->prepare($t1, array(PDO::ATTR_CURSOR => PDO::CURSOR_FWDONLY));


        


        }


        catch(PDOException $e){


                return $this->pack('dbError', $e->getMessage());


        }


?>





does not and so will not throw the exception if your SQL is wrong.





You will need to check that $sth1 is not null.

daniel dot egeberg at gmail dot com 24-May-2009 01:06


You can also pass an array of values to PDOStatement::execute(). This is also secured against SQL injection. You don't necessarily have to use bindParam() or bindValue().

admin at wdfa dot co dot uk 09-Apr-2009 09:52


Note on the SQL injection properties of prepared statements.



Prepared statements only project you from SQL injection IF you use the bindParam or bindValue option.



For example if you have a table called users with two fields, username and email and someone updates their username you might run



UPDATE `users` SET `user`='$var'



where $var would be the user submitted text. 



Now if you did 

<?php

$a=new PDO("mysql:host=localhost;dbname=database;","root","");

$b=$a->prepare("UPDATE `users` SET user='$var'");

$b->execute();

?>



and the user had entered  User', email='test for a test the injection would occur and the email would be updated to test as well as the user being updated to User.



Using bindParam as follows

 <?php

$var="User', email='test";

$a=new PDO("mysql:host=localhost;dbname=database;","root","");

$b=$a->prepare("UPDATE `users` SET user=:var");

$b->bindParam(":var",$var);

$b->execute();

?>



The sql would be escaped and update the username to User', email='test'

ak_9jsz 18-May-2008 10:16


Using cursors doesn't work with SQLite 3.5.9. I get an error message when it gets to the execute() method.



Some of you might be saying "duh!" but i was surprised to see TRIGGER support in SQLite, so i had to try. :)



I wanted to use Absolute referencing on a Scrollable cursor and i only wanted one column of data. So i used this instead of a cursor.



<?php



$dbo = new PDO('sqlite:tdb');

$sql = 'SELECT F1, F2 FROM tblA WHERE F1 <> "A";';

$res = $dbo->prepare($sql);

$res->execute();

$resColumn = $res->fetchAll(PDO::FETCH_COLUMN, 0);



for($r=0;$r<=3;$r++)

    echo 'Row '. $r . ' returned: ' . $resColumn[$r] . "\n";



$dbo = null;

$res = null;

?>

Stan 14-Nov-2007 07:35


Using prepared SELECT statements on a MySQL database prior to MySQL 5.1.17 can lead to SERIOUS performance degradation.



Quote from http://dev.mysql.com/doc/refman/5.1/en/query-cache.html :



>> The query cache is not used for server-side prepared statements before MySQL 5.1.17 <<



The MySQL query cache buffers complete query results and is used to satisfy repeated identical queries if the underlying tables do not change in the meantime - just what happens all the time in a typical web application. It speeds up queries by a several hundred to a several thousand percent.



Obviously, it doesn't make much sense to give up query caching for the relatively small performance benefit of prepared statements (i.e. the DBMS not having to parse and optimize the same query multiple times) - so using PDO->query() for SELECT statements is probably the better choice i you're connecting to MySQL < 5.1.17.

www.onphp5.com 07-Apr-2007 06:41


Please note that the statement regarding driver_options is misleading:



"This array holds one or more key=>value pairs to set attribute values for the PDOStatement object that this method returns. You would most commonly use this to set the PDO::ATTR_CURSOR value to PDO::CURSOR_SCROLL to request a scrollable cursor. Some drivers have driver specific options that may be set at prepare-time"



From this you might think that scrollable cursors work for all databases, but they don't! Check out this bug report:

http://bugs.php.net/bug.php?id=34625

johniskew 22-Feb-2007 08:03


If you need to create variable sql statements in a prepare statement...for example you may need to construct a sql query with zero, one, two, etc numbers of arguments...here is a way to do it without a lot of if/else statements needed to glue the sql together:



<?php



    public function matchCriteria($field1=null,$field2=null,$field3=null) {

        $db=DB::conn();

        $sql=array();

        $paramArray=array();

        if(!empty($field1)) {

            $sql[]='field1=?';

            $paramArray[]=$field1;

        }

        if(!empty($field2)) {

            $sql[]='field2=?';

            $paramArray[]=$field2;

        }

        if(!empty($field3)) {

            $sql[]='field3=?';

            $paramArray[]=$field3;

        }

        $rs=$db->prepare('SELECT * FROM mytable'.(count($paramArray)>0 ? ' WHERE '.join(' AND ',$sql) : ''));

        $result=$rs->execute($paramArray);

        if($result) {

            return $rs;

        }

        return false;

    }



?>

jacques at chester dot id dot au 13-Nov-2006 06:07


Watch out: prepared statements on MySQL barf if you try to pass in substitution tables for sql keywords, table names, view names and field names.



For example, this will not work:



$stmt = $dbh->prepare("SELECT :sqlAggregate( :fieldName) from :viewName";



You will get a MySQL error 1064 and a very unhelpful error message.



In short, you need to do string substitutions into your queries if you want configurable table names, aggregate keywords etc etc.



Which doesn't help at all in the "protection from injection attacks" thing. A very annoying discovery.

william dot clarke at gmail dot com 31-Aug-2006 03:58


Surely if you want to use prepared statements that way you should use the syntax in the second example:



eg. 



instead of:

select id,name from demo_de where name LIKE :name OR name=:name 



use:

select id,name from demo_de where name LIKE ? OR name=?



I believe you are supposed to either use distinct named parameters (name, name1) OR anonymous parameters (?s)

roth at egotec dot com 30-Aug-2006 01:58


Attention using MySQL and prepared statements.

Using a placeholder multiple times inside a statement doesn't work. PDO just translates the first occurance und leaves the second one as is.



select id,name from demo_de where name LIKE :name OR name=:name



You have to use



select id,name from demo_de where name LIKE :name OR name=:name2



and bind name two times. I don't know if other databases (for example Oracle or MSSQL) support multiple occurances. If that's the fact, then the PDO behaviour for MySQL should be changed.

add a note