Zend_Db_Profiler を使用すると、クエリの情報を取得することができます。 アダプタが実際に実行したクエリの内容や実行所要時間などが取得でき、 余計なデバッグコードをクラスに追加しなくてもクエリを調べられるようになります。 さらに、条件を指定して特定のクエリだけの情報を取得することもできます。

プロファイラを有効にするには、アダプタのコンストラクタで指定するか、 あるいは後からアダプタに指示します。

<?php
require_once 'Zend/Db.php';

$params = array(
    'host'     => '127.0.0.1',
    'username' => 'webuser',
    'password' => 'xxxxxxxx',
    'dbname'   => 'test'
    'profiler' => true  // プロファイラを使用します。false (デフォルト) にすると無効になります。
);

$db = Zend_Db::factory('PDO_MYSQL', $params);

// プロファイラを無効にします
$db->getProfiler()->setEnabled(false);

// プロファイラを有効にします
$db->getProfiler()->setEnabled(true);
        

'profiler' オプションの値には柔軟性があり、 その型に応じて、さまざまな形式で解釈されます。 たいていは単純な boolean 値を指定することになるでしょうが、 その他の値を指定することでプロファイラの振る舞いをカスタマイズすることも可能です。

boolean 引数 true を指定すると、 プロファイラを有効にします。あるいは false にすると、プロファイラを無効にします。プロファイラのクラスは、 そのアダプタのデフォルトのプロファイラクラス (たとえば Zend_Db_Profiler) となります。

$params['profiler'] = true;
$db = Zend_Db::factory('PDO_MYSQL', $params);
            

文字列引数を指定した場合は、それは独自のプロファイラクラスのクラス名として解釈されます。 このクラスは、Zend_Db_Profiler あるいはそのサブクラスでなければなりません。 作成されたプロファイラのインスタンスはデフォルトでは無効になっているので、 別途 setEnabled() をコールして有効化する必要があります。

$params['profiler'] = 'MyProject_Db_Profiler'
$db = Zend_Db::factory('PDO_MYSQL', $params);
$db->getProfiler()->setEnabled(true);
            

Zend_Db_Profiler オブジェクトのインスタンスを指定した場合は、 アダプタはそのオブジェクトを使用します。このオブジェクトの型は Zend_Db_Profiler あるいはそのサブクラスである必要があります。 このプロファイラは、別途 setEnabled() をコールするまでは無効になっています。

$profiler = MyProject_Db_Profiler(true);
$params['profiler'] = $profiler;
$db = Zend_Db::factory('PDO_MYSQL', $params);
$db->getProfiler()->setEnabled(true);
            

引数には連想配列を指定することもできます。この連想配列のキーには 'enabled'、'class' そして 'instance' のいずれか (あるいはすべて) を含めることができます。これらはそれぞれ、ここまで説明した boolean、文字列、そしてオブジェクト型の引数に対応します。

$params['profiler'] = array(
    'enabled' => true,
    'class' => 'MyProject_Db_Profiler'
);
$db = Zend_Db::factory('PDO_MYSQL', $params);
            

引数には Zend_Config オブジェクトを指定することもできます。 このオブジェクトのプロパティには 'enabled' と 'class' のいずれか (あるいは両方) を含めます。これらはそれぞれ、 先ほどの連想配列の同名のキーと同じ扱いになります。 Zend_Config オブジェクトにはオブジェクトのインスタンスを含めることができません。 たとえば、以下のような内容の "config.ini" を考えてみましょう。

[main]
db.profiler.class = "MyProject_Db_Profiler"
db.profiler.enabled = true
            

$config = new Zend_Config_Ini('config.ini', 'main');
$params['profiler'] = $config->db->profiler;
$db = Zend_Db::factory('PDO_MYSQL', $params);
            

好きなところでアダプタの getProfiler() メソッドを使用すれば、 プロファイラを取得できます。

<?php
$profiler = $db->getProfiler();
        

これは、Zend_Db_Profiler オブジェクトのインスタンスを返します。 このインスタンスのさまざまなメソッドを使用することで、 クエリの内容を調べることができます。

• getTotalNumQueries() は、 情報を取得したクエリの総数を返します。

• getTotalElapsedSecs() は、 情報を取得したクエリの実行所要時間の合計を返します。

• getQueryProfiles() は、 すべてのクエリ情報を配列で返します。

• getLastQueryProfile() は、最後に (直近に) 実行されたクエリの情報を (そのクエリが 完了したか否かにかかわらず) 返します (クエリが完了していない場合は、終了時刻が null となります)。

• clear() は、スタック上に残っている 過去のクエリ情報をすべて消去します。

getLastQueryProfile() の返り値、および getQueryProfiles() の個々の要素は Zend_Db_Profiler_Query オブジェクトで、 これを使用すると個々のクエリ自体の情報を調べられます。

• getQuery() は、クエリの SQL テキストを返します。 パラメータつきのプリペアドステートメントの場合、 クエリがプリペアされた時点のテキストを返します。 つまり、プレースホルダを含んだままの形式ということです。 実行時に置き換えられた値を知ることはできません。

• getQueryParams() は、 プリペアドクエリを実行する際に使用する、パラメータの値の配列を返します。 ここには、バインドパラメータだけでなく execute() メソッドへの引数も含まれます。 配列のキーは、(1 から始まる) 数値かあるいは (文字列の) パラメータ名となります。

• getElapsedSecs() は、 クエリの実行所要時間を返します。

Zend_Db_Profiler の提供する情報は、 アプリケーションのボトルネックを調査したり クエリをデバッグしたりする場合に有用です。 例えば、直近に実行されたクエリが実際のところどんなものだったのかを知るには次のようにします。

<?php
$query = $profiler->getLastQueryProfile();

echo $query->getQuery();
        

ページの生成に時間がかかっているとしましょう。この場合、 プロファイラを使用してまず全クエリの実行所要秒数を取得します。 それから、個々のクエリを調べ、一番時間がかかっているのはどれかを見つけます。

<?php
$totalTime    = $profiler->getTotalElapsedSecs();
$queryCount   = $profiler->getTotalNumQueries();
$longestTime  = 0;
$longestQuery = null;

foreach ($profiler->getQueryProfiles() as $query) {
    if ($query->getElapsedSecs() > $longestTime) {
        $longestTime  = $query->getElapsedSecs();
        $longestQuery = $query->getQuery();
    }
}

echo '全部で ' . $queryCount . ' 件のクエリが ' . $totalTime . ' 秒で実行されました' . "\n";
echo '平均の所要時間: ' . $totalTime / $queryCount . ' 秒' . "\n";
echo '1 秒あたりのクエリ実行数: ' . $queryCount / $totalTime . "\n";
echo '所要時間の最大値: ' . $longestTime . "\n";
echo "一番時間のかかっているクエリ: \n" . $longestQuery . "\n";
        

単にクエリを調べるだけでなく、どのクエリを調べるのかという 条件を指定することも可能です。以下で説明するメソッドは、 Zend_Db_Profiler インスタンスのメソッドです。

<?php
// 所要時間が 5 秒以上のクエリのみ調べます
$profiler->setFilterElapsedSecs(5);

// 所要時間にかかわらず、すべてのクエリを調べます
$profiler->setFilterElapsedSecs(null);
            

<?php
// SELECT クエリのみを調べます
$profiler->setFilterQueryType(Zend_Db_Profiler::SELECT);

// SELECT、INSERT そして UPDATE クエリを調べます
$profiler->setFilterQueryType(Zend_Db_Profiler::SELECT | Zend_Db_Profiler::INSERT | Zend_Db_Profiler::UPDATE);

// DELETE クエリを調べます (削除されたデータを見つけることができます)
$profiler->setFilterQueryType(Zend_Db_Profiler::DELETE);

// すべてのフィルタを削除します
$profiler->setFilterQueryType(null);
            

<?php
// SELECT クエリの情報のみを取得します
$profiles = $profiler->getQueryProfiles(Zend_Db_Profiler::SELECT);

// SELECT、INSERT そして UPDATE クエリの情報のみを取得します
$profiles = $profiler->getQueryProfiles(Zend_Db_Profiler::SELECT | Zend_Db_Profiler::INSERT | Zend_Db_Profiler::UPDATE);

// DELETE クエリの情報を取得します (データがなぜ削除されたのかを
// 知ることができます)
$profiles = $profiler->getQueryProfiles(Zend_Db_Profiler::DELETE);