Ars Longa, Vita Brevis » Kohana

Исправление ошибки в INSERT INTO … SELECT в Kohana 3 при использовании конфигурации базы данных, отличной от default

Wandering Soul — Thu, 12 Aug 2010 07:40:55 +0000

Исправление короче описания

Ситуация: нужно выполнить запрос вида

INSERT INTO `table` (`col1`, `col2`) SELECT * FROM `table` WHERE `col1` <> 0;

Если использовать конфигурацию default, то всё отлично работает. Если же использовать другую конфигурацию, то можем получить ошибку соединения с базой данных и исключение.

Например:

// application/config/database.php
// Важно, чтобы в конфигурации default нельзя было подключиться к серверу
return array(
'test' => array(
'type' => 'mysql',
'connection' => array(
'hostname' => 'localhost',
'database' => 'test',
'username' => 'username',
'password' => 'password',
'persistent' => FALSE,
),
'table_prefix' => '',
'charset' => 'utf8',
'caching' => FALSE,
'profiling' => TRUE,
),
);
?>

// application/classes/controller/welcome.php

class Controller_Welcome extends Controller
{
public function action_index()
{
$this->request->response = DB::insert('test', array('col1', 'col2'))
->select(DB::select()->from('test')->where('column1', '<>', '0'))
->compile(Database::instance('test')) . "\n";
}
}

?>

Важно, чтобы правая часть условия в where() была строкой.

В результате если мы запустим проект, то получим что-то вида:

INSERT INTO `test` (`column1`, `column2`) ErrorException [ 2 ]: mysql_connect(): Access denied for user 'www-data'@'localhost' (using password: NO) ~ MODPATH/database/classes/kohana/database/mysql.php [ 56 ]

Связано это с особенностью реализации метода Kohana_Database_Query_Builder_Insert::compile():

public function compile(Database $db)
{
// Start an insertion query
$query = 'INSERT INTO '.$db->quote_table($this->_table);

// Не интересно
// …

if (is_array($this->_values))
{
// Не интересно
// …
$query .= 'VALUES '.implode(', ', $groups);
}
else
{
// Add the sub-query
$query .= (string) $this->_values;
}

return $query;
}

Строка $query .= (string) $this->_values; вызывает метод compile() для SELECT, но так как конфигурация базы данных не передаётся, используется конфигурация default.

Самое простое исправление очевидно: заменить строку

$query .= (string) $this->_values;

на

$query .= $this->_values->compile($db);

Тем не менее, если SELECT использует одну базу данных, а INSERT — другую, и при этом используются разные charset’ы (да, это не самое большое извращение — бывают и хуже), этого будет недостаточно. В этом случае нужно добавить дополнительный параметр в метод select(), указывающий, какую конфигурацию использовать. Требуемые изменения кода тривиальны, посему остаются упражнением интересующемуся читателю.

При использовании материалов блога наличие активной не закрытой от индексирования ссылки на источник обязательно.

Поддержка JOIN в запросах DELETE для Kohana 3

Wandering Soul — Wed, 11 Aug 2010 10:48:13 +0000

Добавление поддержки multiple-table DELETE в Query Builder Kohana 3

Иногда бывает полезно выполнить удаление записей в нескольких связанных таблицах, благо синтаксис позволяет. Разумеется, есть такая вещь как каскадное удаление записей, но в случае с MySQL (а именно — таблицами MyISAM) на неё надеяться не приходится.

Модуль Database из Kohana 3 не умеет использовать JOIN с операцией DELETE. Нужно ему помочь.

class Database_Query_Builder_Delete extends Kohana_Database_Query_Builder_Delete
{
protected $_to_delete = array();
protected $_join = array();
protected $_last_join;

/**
* Adds addition tables to "JOIN ...".
*
* @param mixed column name or array($column, $alias) or object
* @param string join type (LEFT, RIGHT, INNER, etc)
* @return Database_Query_Builder_Delete
*/
public function join($table, $type = NULL)
{
$this->_join[] = $this->_last_join = new Database_Query_Builder_Join($table, $type);

return $this;
}

public function delete_table($table)
{
$this->_to_delete[] = $table;
}

/**
* Adds "ON ..." conditions for the last created JOIN statement.
*
* @param mixed column name or array($column, $alias) or object
* @param string logic operator
* @param mixed column name or array($column, $alias) or object
* @return $this
*/
public function on($c1, $op, $c2)
{
$this->_last_join->on($c1, $op, $c2);

return $this;
}

/**
* Compile the SQL query and return it.
*
* @param Database Database instance
* @return string
*/
public function compile(Database $db)
{
$query = 'DELETE';
if ($this->_to_delete) {
$query .= ' ' . join(', ', array_map(array($db, 'quote_identifier'), $this->_to_delete));
}

$query .= ' FROM ' . $db->quote_table($this->_table);

if ($this->_join) {
$query .= ' ' . $this->_compile_join($db, $this->_join);
}

if ($this->_where) {
$query .= ' WHERE ' . $this->_compile_conditions($db, $this->_where);
}

if (!$this->_join) {
if ($this->_order_by) {
$query .= ' ' . $this->_compile_order_by($db, $this->_order_by);
}

if ($this->_limit !== null) {
$query .= ' LIMIT ' . $this->_limit;
}
}
else {
throw new Kohana_Exception('Cannot use ORDER BY or LIMIT in a multiple-table DELETE');
}

return $query;
}

public function reset()
{
parent::reset();
$this->_to_delete = array();
$this->_join = array();
$this->_last_join = null;
}
}

?>

Данный класс добавляет функциональность, связанную с удалением данных из нескольких таблиц, в Query Builder. Использование покажу на примерах:

Запросу

DELETE t1, t2 FROM t1 INNER JOIN t2 INNER JOIN t3
WHERE t1.id=t2.id AND t2.id=t3.id;

соответствует код

DB::delete('t1')
->join('t2', 'INNER')
->on('t1.id', '=', 't2.id')
->join('t3', 'INNER')
->on('t2.id', '=', 't3.id')
->delete_table('t1')
->delete_table('t2');

Запросу

DELETE FROM t1 INNER JOIN t2 INNER JOIN t3
WHERE t1.id=t2.id AND t2.id=t3.id;

соответствует код

DB::delete('t1')
->join('t2', 'INNER')
->on('t1.id', '=', 't2.id')
->join('t3', 'INNER')
->on('t2.id', '=', 't3.id');

Как видим, метод Database_Query_Builder_Delete::delete_table() задаёт имена таблиц, которые нужно удалить; если данный метод не вызывать, будут удалены все таблицы, перечисленные в запросе.

Патч для кэширования пустых результатов запросов в Kohana

Wandering Soul — Wed, 11 Aug 2010 08:25:23 +0000

Простое исправление досадного недоразумения

Проблема: Kohana 3 (3.0.7, возможно, ранние версии) не может брать результаты запросов из кэша, если запрос вернул пустой результат.

Решение проблемы.

Разгадка кроется в файле modules/database/classes/kohana/database/query.php. Дело в том, что в PHP проверки вида if ($condition) возвращают false, если вычисленное значение $condition — 0, null, false, "", array(), ….

Поэтому в такой проверке:

if ($result = Kohana::cache($cache_key, NULL, $this->_lifetime))
{
// Return a cached result
return new Database_Result_Cached($result, $sql, $this->_as_object);
}

условие всегда будет ложно для пустых результатов.

Исправляется просто: из исходного кода Kohana::cache() видно, что Kohana::cache() возвращает null, если объект в кэше не найден либо произошла ошибка. Следовательно,

if (($result = Kohana::cache($cache_key, NULL, $this->_lifetime)) !== null)
{
// Return a cached result
return new Database_Result_Cached($result, $sql, $this->_as_object);
}

даст корректный результат.

Ошибка в ORM Kohana 3 при использовании префиксов таблиц

Vladimir — Fri, 19 Feb 2010 11:00:51 +0000

Патч для решения проблемы прилагается

Ситуация: имеем две таблицы: пользователи и подписки:

CREATE TABLE prefix_users (
id INTEGER NOT NULL PRIMARY KEY,
name VARCHAR(255) NOT NULL
);

CREATE TABLE prefix_subscriptions (
id INTEGER NOT NULL PRIMARY KEY,
user_id INTEGER UNSIGNED NOT NULL,
some_data TEXT NOT NULL
);

Один пользователь может иметь несколько подписок, одна подписка может принадлежать только одному пользователю.

Настройки соединения с базой данных (application/config/database.php) имеют следующий вид:

return array(
'default' => array(
'type' => 'mysql',
'connection' => array(
'hostname' => 'localhost',
'username' => 'user',
'password' => 'pass',
'persistent' => FALSE,
'database' => 'database',
),
'table_prefix' => 'prefix_',
'charset' => 'utf8',
'caching' => FALSE,
'profiling' => TRUE,
),
);

Модели в Kohana 3 будут иметь следующий вид:

// application/classes/model/user.php
class Model_User extends ORM
{
protected $_has_many = array(
'subscriptions' => array(
'foreign_key' => 'user_id',
'model' => 'Subscription',
),
);
}

// application/classes/model/subscription.php
class Model_Subscription extends ORM
{
protected $_belongs_to = array(
'user' => array(
'foreign_key' => 'user_id',
'model' => 'User',
),
);
}

Допустим, что в контроллере у нас есть вызов наподобие

ORM::factory('Subscription')->with('user')->find_all();

Что произойдёт? А ничего хорошего:

Database_Exception [ 1054 ]: Unknown column 'prefix_user.id' in 'field list' [ SELECT `prefix_user`.`id` AS `user:id`, `prefix_user`.`name` AS `user:name`, `prefix_subscriptions`.* FROM `prefix_subscriptions` LEFT JOIN `prefix_users` AS `user` ON (`prefix_user`.`id` = `prefix_subscriptions`.`user_id`) ORDER BY `prefix_subscriptions`.`id` ASC ] ~ MODPATH/database/classes/kohana/database/mysql.php [ 183 ]

Почему? Модуль ORM предполагал, что запрос будет выглядеть так:

SELECT `user`.`id` AS `user:id`, `user`.`name` AS `user:name`, `subscriptions`.*
FROM `subscriptions`
LEFT JOIN `users` AS `user` ON (`user`.`id` = `subscriptions`.`user_id`)
ORDER BY `subscriptions`.`id` ASC

Так бы и было, если бы таблицы не имели префикса. ORM передаёт Database поля в виде user.id, Database их экранирует в `user`.`id`. Проблема в том, что Database ничего не знает о псевдонимах таблиц (users AS user в JOIN), а ORM ничего не знает о префиксах таблиц. Поэтому Database с чистой совестью добавляет префикс ко всему, что находится в именах слева от точки. В результате вместо SELECT `user`.`id` AS `user:id` получаем SELECT `prefix_user`.`id` AS `user:id`.

Есть два решения:

Унаследовать свой класс ORM от Kohana_ORM и исправить в нём метод with();
Исправить метод Kohana_ORM::with().

Результат получится примерно одинаковым — код будет выглядеть так:

public function with($target_path)
{
if (isset($this->_with_applied[$target_path]))
{
// Don't join anything already joined
return $this;
}

// Split object parts
$aliases = explode(':', $target_path);
$target = $this;
foreach ($aliases as $alias)
{
// Go down the line of objects to find the given target
$parent = $target;
$target = $parent->_related($alias);

if ( ! $target)
{
// Can't find related object
return $this;
}
}

// Target alias is at the end
$target_alias = $alias;

// Pop-off top alias to get the parent path (user:photo:tag becomes user:photo - the parent table prefix)
array_pop($aliases);
$parent_path = implode(':', $aliases);

if (empty($parent_path))
{
// Use this table name itself for the parent path
$parent_path = $this->_table_name;
}
else
{
if( ! isset($this->_with_applied[$parent_path]))
{
// If the parent path hasn't been joined yet, do it first (otherwise LEFT JOINs fail)
$this->with($parent_path);
}
}

// Add to with_applied to prevent duplicate joins
$this->_with_applied[$target_path] = TRUE;

// Use the keys of the empty object to determine the columns
foreach (array_keys($target->_object) as $column)
{
$name = '"'.$target_path.'"."'.$column . '"';
$alias = $target_path.':'.$column;

// Add the prefix so that load_result can determine the relationship
$this->select(array($name, $alias));
}

if (isset($parent->_belongs_to[$target_alias]))
{
// Parent belongs_to target, use target's primary key and parent's foreign key
$join_col1 = '"'.$target_path.'"."'.$target->_primary_key.'"';
$join_col2 = $parent_path.'.'.$parent->_belongs_to[$target_alias]['foreign_key'];
}
else
{
// Parent has_one target, use parent's primary key as target's foreign key
$join_col1 = $parent_path.'.'.$parent->_primary_key;
$join_col2 = '"'.$target_path.'"."'.$parent->_has_one[$target_alias]['foreign_key'] .'"';
}

// Join the related object into the result
$this->join(array($target->_table_name, $target_path), 'LEFT')->on($join_col1, '=', $join_col2);

return $this;
}

Патч по объёму гораздо меньше:

--- kohana/modules/orm/classes/kohana/orm.php
+++ kohana/modules/orm/classes/kohana/orm.php
@@ -637,7 +637,7 @@
// Use the keys of the empty object to determine the columns
foreach (array_keys($target->_object) as $column)
{
- $name = $target_path.'.'.$column;
+ $name = '"'.$target_path.'"."'.$column . '"';
$alias = $target_path.':'.$column;

// Add the prefix so that load_result can determine the relationship
@@ -647,14 +647,14 @@
if (isset($parent->_belongs_to[$target_alias]))
{
// Parent belongs_to target, use target's primary key and parent's foreign key
- $join_col1 = $target_path.'.'.$target->_primary_key;
+ $join_col1 = '"'.$target_path.'"."'.$target->_primary_key.'"';
$join_col2 = $parent_path.'.'.$parent->_belongs_to[$target_alias]['foreign_key'];
}
else
{
// Parent has_one target, use parent's primary key as target's foreign key
$join_col1 = $parent_path.'.'.$parent->_primary_key;
- $join_col2 = $target_path.'.'.$parent->_has_one[$target_alias]['foreign_key'];
+ $join_col2 = '"'.$target_path.'"."'.$parent->_has_one[$target_alias]['foreign_key'] .'"';
}

// Join the related object into the result

Скачать патч (unified diff).

Идея в том, что имена псевдонимов заключаются в двойные кавычки — в этом случае Database не занимается «самодеятельностью» в виде добавления префиксов куда надо и не надо.

Проверялось на Kohana 3.0.3

Отчёт об ошибке в трекере Kohana

SQLMon для Kohana 3

Vladimir — Tue, 09 Feb 2010 19:16:01 +0000

Мониторинг SQL-запросов в Kohana 3

Продолжая славную традицию реализации SQLMon под различные CMS/фреймворки, написал одному заказчику модуль для Kohana 3.

SQLMon для Kohana 3 интегрируется в иерархию классов Database (встраивается между классами Database_MySQL и Kohana_Database_MySQL) и реализует обёртку над методом Kohana_Database_MySQL::query(), измеряя время выполнения запроса, объём потребляемой памяти, записывая код ошибки запроса, трассу вызовов и EXPLAIN запроса (причём не только для SELECT, но и UPDATE/DELETE и INSERT/REPLACE INTO … AS или CREATE TABLE … AS) — всё то же самое, что и SQLMon для WordPress.

Данный модуль будет полезен разработчикам для анализа производительности запросов MySQL и поиска решений для их оптимизации. Перед использованием модуля рекомендуется прочитать статью «Optimizing Queries with EXPLAIN».

Использование модуля. Модуль должен быть распакован в каталог modules проекта (после распаковки появится каталог sqlmon). Затем модуль должен быть активирован в файле application/bootstrap.php. Очень важно, чтобы модуль подключался перед модулем database — это связано с особенностями поиска классов в Kohana 3.

Например:

Kohana::modules(array(
'sqlmon' => MODPATH.'sqlmon', // SQL Monitor — обязательно перед Database
'database' => MODPATH.'database', // Database access
'orm' => MODPATH.'orm', // Object Relationship Mapping
'pagination' => MODPATH.'pagination', // Paging of results
));

Для отображения статистики нужно выполнить

echo View::factory('sqlmon/sqlmon'); ?>

Результатом будет нечто вида (скриншот можно кликнуть):

Настройка. SQLMon использует файлы конфигурации модуля Database — config/database.php. Для контроля поведения SQLMon нужно использовать параметры:

backtrace — boolean (по умолчанию true) — должен ли SQLMon отображать трассу вызовов (то, что отображается синим цветом на скриншоте выше);
explain — boolean (по умолчанию true) — должен ли SQLMon отображать план выполнения запросов (EXPLAIN).

Пример файла конфигурации:

return array(
'default' => array(
'type' => 'mysql',
'profiling' => true,
'charset' => 'utf8',
'table_prefix' => '',
// Настройки SQLMon
'backtrace' => true,
'explain' => true,
// ---
'connection' => array(
'username' => 'root',
'password' => 'M1dn19ht',
'hostname' => 'localhost',
'persistent' => false,
'database' => 'feedfetcher'
),
)
);
?>

Скачать SQLMon для Kohana 3.