Update PicoDb and improve schema migration error handling

This commit is contained in:
Frédéric Guillot 2014-09-15 13:23:55 +02:00
parent e29a22442d
commit 871f1d1d64
7 changed files with 210 additions and 26 deletions

View File

@ -67,6 +67,22 @@ PicoDb\Database::bootstrap('db', function() {
return $db;
}
else {
die('Unable to migrate database schema.');
$errors = $db->getLogMessages();
$pdo = new \PDO('sqlite::memory:');
$result = $pdo->query('select sqlite_version()', PDO::FETCH_COLUMN, 0);
$sqlite_version = $result ? $result->fetch() : '?';
$html = 'Unable to migrate the database schema, <strong>please copy and paste this message and create a bug report:</strong><hr/>';
$html .= '<pre><code>';
$html .= (isset($errors[0]) ? $errors[0] : 'Unknown SQL error').PHP_EOL.PHP_EOL;
$html .= '- PHP version: '.phpversion().PHP_EOL;
$html .= '- SAPI: '.php_sapi_name().PHP_EOL;
$html .= '- PDO Sqlite version: '.phpversion('pdo_sqlite').PHP_EOL;
$html .= '- Sqlite version: '.$sqlite_version.PHP_EOL;
$html .= '- OS: '.php_uname();
$html .= '</code></pre>';
die($html);
}
});

View File

@ -19,7 +19,17 @@ class Database
case 'sqlite':
require_once __DIR__.'/Drivers/Sqlite.php';
$this->pdo = new Sqlite($settings['filename']);
$this->pdo = new Sqlite($settings);
break;
case 'mysql':
require_once __DIR__.'/Drivers/Mysql.php';
$this->pdo = new Mysql($settings);
break;
case 'postgres':
require_once __DIR__.'/Drivers/Postgres.php';
$this->pdo = new Postgres($settings);
break;
default:

76
vendor/PicoDb/Drivers/Mysql.php vendored Normal file
View File

@ -0,0 +1,76 @@
<?php
namespace PicoDb;
class Mysql extends \PDO {
private $schema_table = 'schema_version';
public function __construct(array $settings)
{
$required_atttributes = array(
'hostname',
'username',
'password',
'database',
'charset',
);
foreach ($required_atttributes as $attribute) {
if (! isset($settings[$attribute])) {
throw new \LogicException('This configuration parameter is missing: "'.$attribute.'"');
}
}
$dsn = 'mysql:host='.$settings['hostname'].';dbname='.$settings['database'];
$options = array(
\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES '.$settings['charset']
);
parent::__construct($dsn, $settings['username'], $settings['password'], $options);
if (isset($settings['schema_table'])) {
$this->schema_table = $settings['schema_table'];
}
}
public function getSchemaVersion()
{
$this->exec("CREATE TABLE IF NOT EXISTS `".$this->schema_table."` (`version` INT DEFAULT '0')");
$rq = $this->prepare('SELECT `version` FROM `'.$this->schema_table.'`');
$rq->execute();
$result = $rq->fetch(\PDO::FETCH_ASSOC);
if (isset($result['version'])) {
return (int) $result['version'];
}
else {
$this->exec('INSERT INTO `'.$this->schema_table.'` VALUES(0)');
}
return 0;
}
public function setSchemaVersion($version)
{
$rq = $this->prepare('UPDATE `'.$this->schema_table.'` SET `version`=?');
$rq->execute(array($version));
}
public function getLastId()
{
return $this->lastInsertId();
}
public function escapeIdentifier($value)
{
if (strpos($value, '.') !== false) return $value;
return '`'.$value.'`';
}
}

73
vendor/PicoDb/Drivers/Postgres.php vendored Normal file
View File

@ -0,0 +1,73 @@
<?php
namespace PicoDb;
class Postgres extends \PDO {
private $schema_table = 'schema_version';
public function __construct(array $settings)
{
$required_atttributes = array(
'hostname',
'username',
'password',
'database',
);
foreach ($required_atttributes as $attribute) {
if (! isset($settings[$attribute])) {
throw new \LogicException('This configuration parameter is missing: "'.$attribute.'"');
}
}
$dsn = 'pgsql:host='.$settings['hostname'].';dbname='.$settings['database'];
parent::__construct($dsn, $settings['username'], $settings['password']);
if (isset($settings['schema_table'])) {
$this->schema_table = $settings['schema_table'];
}
}
public function getSchemaVersion()
{
$this->exec("CREATE TABLE IF NOT EXISTS ".$this->schema_table." (version SMALLINT DEFAULT 0)");
$rq = $this->prepare('SELECT version FROM '.$this->schema_table.'');
$rq->execute();
$result = $rq->fetch(\PDO::FETCH_ASSOC);
if (isset($result['version'])) {
return (int) $result['version'];
}
else {
$this->exec('INSERT INTO '.$this->schema_table.' VALUES(0)');
}
return 0;
}
public function setSchemaVersion($version)
{
$rq = $this->prepare('UPDATE '.$this->schema_table.' SET version=?');
$rq->execute(array($version));
}
public function getLastId()
{
$rq = $this->prepare('SELECT LASTVAL()');
$rq->execute();
return $rq->fetchColumn();
}
public function escapeIdentifier($value)
{
return $value;
}
}

View File

@ -5,9 +5,19 @@ namespace PicoDb;
class Sqlite extends \PDO {
public function __construct($filename)
public function __construct(array $settings)
{
parent::__construct('sqlite:'.$filename);
$required_atttributes = array(
'filename',
);
foreach ($required_atttributes as $attribute) {
if (! isset($settings[$attribute])) {
throw new \LogicException('This configuration parameter is missing: "'.$attribute.'"');
}
}
parent::__construct('sqlite:'.$settings['filename']);
$this->exec('PRAGMA foreign_keys = ON');
}
@ -20,8 +30,7 @@ class Sqlite extends \PDO {
$result = $rq->fetch(\PDO::FETCH_ASSOC);
if (isset($result['user_version'])) {
return $result['user_version'];
return (int) $result['user_version'];
}
return 0;

View File

@ -18,7 +18,6 @@ class Schema
$current_version = $this->db->getConnection()->getSchemaVersion();
if ($current_version < $last_version) {
return $this->migrateTo($current_version, $last_version);
}
@ -37,20 +36,15 @@ class Schema
$function_name = '\Schema\version_'.$i;
if (function_exists($function_name)) {
call_user_func($function_name, $this->db->getConnection());
$this->db->getConnection()->setSchemaVersion($i);
}
else {
throw new \LogicException('To execute a database migration, you need to create this function: "'.$function_name.'".');
}
}
$this->db->closeTransaction();
}
catch (\PDOException $e) {
$this->db->setLogMessage($function_name.' => '.$e->getMessage());
$this->db->cancelTransaction();
return false;
}

View File

@ -4,6 +4,9 @@ namespace PicoDb;
class Table
{
const SORT_ASC = 'ASC';
const SORT_DESC = 'DESC';
private $table_name = '';
private $sql_limit = '';
private $sql_offset = '';
@ -67,12 +70,7 @@ class Table
$result = $this->db->execute($sql, $values);
if ($result !== false && $result->rowCount() > 0) {
return true;
}
return false;
return $result !== false && $result->rowCount() > 0;
}
@ -104,7 +102,9 @@ class Table
$this->conditions()
);
return false !== $this->db->execute($sql, $this->values);
$result = $this->db->execute($sql, $this->values);
return $result !== false && $result->rowCount() > 0;
}
@ -260,10 +260,10 @@ class Table
}
public function orderBy($column, $order = 'ASC')
public function orderBy($column, $order = self::SORT_ASC)
{
$order = strtoupper($order);
$order = $order === 'ASC' || $order === 'DESC' ? $order : 'ASC';
$order = $order === self::SORT_ASC || $order === self::SORT_DESC ? $order : self::SORT_ASC;
if ($this->sql_order === '') {
$this->sql_order = ' ORDER BY '.$this->db->escapeIdentifier($column).' '.$order;
@ -279,10 +279,10 @@ class Table
public function asc($column)
{
if ($this->sql_order === '') {
$this->sql_order = ' ORDER BY '.$this->db->escapeIdentifier($column).' ASC';
$this->sql_order = ' ORDER BY '.$this->db->escapeIdentifier($column).' '.self::SORT_ASC;
}
else {
$this->sql_order .= ', '.$this->db->escapeIdentifier($column).' ASC';
$this->sql_order .= ', '.$this->db->escapeIdentifier($column).' '.self::SORT_ASC;
}
return $this;
@ -292,10 +292,10 @@ class Table
public function desc($column)
{
if ($this->sql_order === '') {
$this->sql_order = ' ORDER BY '.$this->db->escapeIdentifier($column).' DESC';
$this->sql_order = ' ORDER BY '.$this->db->escapeIdentifier($column).' '.self::SORT_DESC;
}
else {
$this->sql_order .= ', '.$this->db->escapeIdentifier($column).' DESC';
$this->sql_order .= ', '.$this->db->escapeIdentifier($column).' '.self::SORT_DESC;
}
return $this;
@ -377,6 +377,12 @@ class Table
$sql = sprintf('%s = ?', $this->db->escapeIdentifier($column));
break;
case 'neq':
case 'notequal':
case 'notequals':
$sql = sprintf('%s != ?', $this->db->escapeIdentifier($column));
break;
case 'gt':
case 'greaterthan':
$sql = sprintf('%s > ?', $this->db->escapeIdentifier($column));