From 20f504253b151a9ebad8c0a0a5ed296a94698ea3 Mon Sep 17 00:00:00 2001
From: zYne <zYne@625475ce-881a-0410-a577-b389adb331d8>
Date: Thu, 19 Oct 2006 20:56:59 +0000
Subject: [PATCH] added Mysql export driver + updated some datadict drivers
---
lib/Doctrine/DataDict/Mysql.php | 96 +++++++-
lib/Doctrine/DataDict/Sqlite.php | 8 +-
lib/Doctrine/Export.php | 10 +-
lib/Doctrine/Export/Mysql.php | 410 +++++++++++++++++++++++++++++++
tests/ExportMysqlTestCase.php | 7 +
tests/UnitTestCase.php | 2 +
6 files changed, 527 insertions(+), 6 deletions(-)
create mode 100644 lib/Doctrine/Export/Mysql.php
create mode 100644 tests/ExportMysqlTestCase.php
diff --git a/lib/Doctrine/DataDict/Mysql.php b/lib/Doctrine/DataDict/Mysql.php
index 27e948233..2b5f27191 100644
--- a/lib/Doctrine/DataDict/Mysql.php
+++ b/lib/Doctrine/DataDict/Mysql.php
@@ -24,10 +24,104 @@
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
+ * @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
class Doctrine_DataDict_Mysql extends Doctrine_DataDict {
+ /**
+ * Obtain DBMS specific SQL code portion needed to declare an text type
+ * field to be used in statements like CREATE TABLE.
+ *
+ * @param array $field associative array with the name of the properties
+ * of the field being declared as array indexes. Currently, the types
+ * of supported field properties are as follows:
+ *
+ * length
+ * Integer value that determines the maximum length of the text
+ * field. If this argument is missing the field should be
+ * declared to have the longest length allowed by the DBMS.
+ *
+ * default
+ * Text value to be used as default for this field.
+ *
+ * notnull
+ * Boolean flag that indicates whether this field is constrained
+ * to not be set to null.
+ * @return string DBMS specific SQL code portion that should be used to
+ * declare the specified field.
+ * @access public
+ */
+ public function getTypeDeclaration($field) {
+ switch ($field['type']) {
+ case 'array':
+ case 'object':
+ case 'string':
+ if (empty($field['length']) && array_key_exists('default', $field)) {
+ $field['length'] = $this->dbh->varchar_max_length;
+ }
+
+ $length = (! empty($field['length'])) ? $field['length'] : false;
+ $fixed = (! empty($field['fixed'])) ? $field['fixed'] : false;
+
+ return $fixed ? ($length ? 'CHAR('.$length.')' : 'CHAR(255)')
+ : ($length ? 'VARCHAR('.$length.')' : 'TEXT');
+ case 'clob':
+ if (!empty($field['length'])) {
+ $length = $field['length'];
+ if ($length <= 255) {
+ return 'TINYTEXT';
+ } elseif ($length <= 65532) {
+ return 'TEXT';
+ } elseif ($length <= 16777215) {
+ return 'MEDIUMTEXT';
+ }
+ }
+ return 'LONGTEXT';
+ case 'blob':
+ if (!empty($field['length'])) {
+ $length = $field['length'];
+ if ($length <= 255) {
+ return 'TINYBLOB';
+ } elseif ($length <= 65532) {
+ return 'BLOB';
+ } elseif ($length <= 16777215) {
+ return 'MEDIUMBLOB';
+ }
+ }
+ return 'LONGBLOB';
+ case 'integer':
+ if (!empty($field['length'])) {
+ $length = $field['length'];
+ if ($length <= 1) {
+ return 'TINYINT';
+ } elseif ($length == 2) {
+ return 'SMALLINT';
+ } elseif ($length == 3) {
+ return 'MEDIUMINT';
+ } elseif ($length == 4) {
+ return 'INT';
+ } elseif ($length > 4) {
+ return 'BIGINT';
+ }
+ }
+ return 'INT';
+ case 'boolean':
+ return 'TINYINT(1)';
+ case 'date':
+ return 'DATE';
+ case 'time':
+ return 'TIME';
+ case 'timestamp':
+ return 'DATETIME';
+ case 'float':
+ return 'DOUBLE';
+ case 'decimal':
+ $length = !empty($field['length']) ? $field['length'] : 18;
+ return 'DECIMAL('.$length.','.$this->dbh->options['decimal_places'].')';
+ }
+ return '';
+ }
/**
* lists all databases
*
@@ -111,7 +205,7 @@ class Doctrine_DataDict_Mysql extends Doctrine_DataDict {
* @return array
*/
public function listTables($database = null) {
- $sql = "SHOW TABLES";
+ $sql = 'SHOW TABLES';
return $this->dbh->query($sql)->fetchAll(PDO::FETCH_ASSOC);
}
diff --git a/lib/Doctrine/DataDict/Sqlite.php b/lib/Doctrine/DataDict/Sqlite.php
index dfb7ba385..898d6487f 100644
--- a/lib/Doctrine/DataDict/Sqlite.php
+++ b/lib/Doctrine/DataDict/Sqlite.php
@@ -79,7 +79,7 @@ class Doctrine_DataDict_Sqlite extends Doctrine_DataDict {
*/
public function listTableColumns($table) {
- $sql = "PRAGMA table_info($table)";
+ $sql = "PRAGMA table_info($table)";
$result = $this->dbh->query($sql)->fetchAll(PDO::FETCH_ASSOC);
$description = array();
@@ -112,9 +112,9 @@ class Doctrine_DataDict_Sqlite extends Doctrine_DataDict {
* @return array
*/
public function listTables($database = null) {
- $sql = "SELECT name FROM sqlite_master WHERE type='table' "
- . "UNION ALL SELECT name FROM sqlite_temp_master "
- . "WHERE type='table' ORDER BY name";
+ $sql = "SELECT name FROM sqlite_master WHERE type = 'table' "
+ . "UNION ALL SELECT name FROM sqlite_temp_master "
+ . "WHERE type = 'table' ORDER BY name";
$tables = array();
$stmt = $this->dbh->query($sql);
diff --git a/lib/Doctrine/Export.php b/lib/Doctrine/Export.php
index c4de44852..05bb0d020 100644
--- a/lib/Doctrine/Export.php
+++ b/lib/Doctrine/Export.php
@@ -27,7 +27,15 @@
* @license LGPL
*/
class Doctrine_Export {
- public function export() {
+ private $conn;
+
+ private $dbh;
+
+ public function __construct($conn) {
+ $this->conn = $conn;
+ $this->dbh = $conn->getDBH();
+ }
+ public function export() {
$parent = new ReflectionClass('Doctrine_Record');
$conn = Doctrine_Manager::getInstance()->getCurrentConnection();
$old = $conn->getAttribute(Doctrine::ATTR_CREATE_TABLES);
diff --git a/lib/Doctrine/Export/Mysql.php b/lib/Doctrine/Export/Mysql.php
new file mode 100644
index 000000000..64141be84
--- /dev/null
+++ b/lib/Doctrine/Export/Mysql.php
@@ -0,0 +1,410 @@
+<?php
+/*
+ * $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
+Doctrine::autoload('Doctrine_Export');
+/**
+ * Doctrine_Export_Mysql
+ *
+ * @package Doctrine
+ * @author Konsta Vesterinen
+ * @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
+ * @license LGPL
+ */
+class Doctrine_Export_Mysql extends Doctrine_Export {
+ /**
+ * create a new database
+ *
+ * @param string $name name of the database that should be created
+ * @throws PDOException
+ * @return void
+ */
+ public function createDatabase($name) {
+ $query = 'CREATE DATABASE ' . $this->conn->quoteIdentifier($name);
+ $result = $this->dbh->query($query);
+ }
+ /**
+ * drop an existing database
+ *
+ * @param string $name name of the database that should be dropped
+ * @throws PDOException
+ * @access public
+ */
+ public function dropDatabase($name) {
+ $query = 'DROP DATABASE ' . $this->conn->quoteIdentifier($name);
+ $this->dbh->query($query);
+ }
+ /**
+ * create a new table
+ *
+ * @param string $name Name of the database that should be created
+ * @param array $fields Associative array that contains the definition of each field of the new table
+ * The indexes of the array entries are the names of the fields of the table an
+ * the array entry values are associative arrays like those that are meant to be
+ * passed with the field definitions to get[Type]Declaration() functions.
+ * array(
+ * 'id' => array(
+ * 'type' => 'integer',
+ * 'unsigned' => 1
+ * 'notnull' => 1
+ * 'default' => 0
+ * ),
+ * 'name' => array(
+ * 'type' => 'text',
+ * 'length' => 12
+ * ),
+ * 'password' => array(
+ * 'type' => 'text',
+ * 'length' => 12
+ * )
+ * );
+ * @param array $options An associative array of table options:
+ * array(
+ * 'comment' => 'Foo',
+ * 'character_set' => 'utf8',
+ * 'collate' => 'utf8_unicode_ci',
+ * 'collate' => 'utf8_unicode_ci',
+ * 'type' => 'innodb',
+ * );
+ *
+ * @return mixed MDB2_OK on success, a MDB2 error on failure
+ * @access public
+ */
+ public function createTable($name, array $fields, array $options = array()) {
+ if (!$name) {
+ return $this->dbh->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
+ 'no valid table name specified', __FUNCTION__);
+ }
+ if(empty($fields))
+ throw new Doctrine_Export_Exception('no fields specified for table "'.$name.'"');
+
+ $query_fields = $this->getFieldDeclarationList($fields);
+
+ if (!empty($options['primary'])) {
+ $query_fields.= ', PRIMARY KEY ('.implode(', ', array_keys($options['primary'])).')';
+ }
+ $name = $this->conn->quoteIdentifier($name, true);
+ $query = "CREATE TABLE $name ($query_fields)";
+
+ $options_strings = array();
+
+ if (!empty($options['comment'])) {
+ $options_strings['comment'] = 'COMMENT = '.$this->dbh->quote($options['comment'], 'text');
+ }
+
+ if (!empty($options['charset'])) {
+ $options_strings['charset'] = 'DEFAULT CHARACTER SET '.$options['charset'];
+ if (!empty($options['collate'])) {
+ $options_strings['charset'].= ' COLLATE '.$options['collate'];
+ }
+ }
+
+ $type = false;
+ if (!empty($options['type'])) {
+ $type = $options['type'];
+ } elseif ($this->dbh->options['default_table_type']) {
+ $type = $this->dbh->options['default_table_type'];
+ }
+ if ($type) {
+ $options_strings[] = "ENGINE = $type";
+ }
+
+ if (!empty($options_strings)) {
+ $query.= ' '.implode(' ', $options_strings);
+ }
+ return $this->dbh->query($query);
+ }
+ /**
+ * alter an existing table
+ *
+ * @param string $name name of the table that is intended to be changed.
+ * @param array $changes associative array that contains the details of each type
+ * of change that is intended to be performed. The types of
+ * changes that are currently supported are defined as follows:
+ *
+ * name
+ *
+ * New name for the table.
+ *
+ * add
+ *
+ * Associative array with the names of fields to be added as
+ * indexes of the array. The value of each entry of the array
+ * should be set to another associative array with the properties
+ * of the fields to be added. The properties of the fields should
+ * be the same as defined by the Metabase parser.
+ *
+ *
+ * remove
+ *
+ * Associative array with the names of fields to be removed as indexes
+ * of the array. Currently the values assigned to each entry are ignored.
+ * An empty array should be used for future compatibility.
+ *
+ * rename
+ *
+ * Associative array with the names of fields to be renamed as indexes
+ * of the array. The value of each entry of the array should be set to
+ * another associative array with the entry named name with the new
+ * field name and the entry named Declaration that is expected to contain
+ * the portion of the field declaration already in DBMS specific SQL code
+ * as it is used in the CREATE TABLE statement.
+ *
+ * change
+ *
+ * Associative array with the names of the fields to be changed as indexes
+ * of the array. Keep in mind that if it is intended to change either the
+ * name of a field and any other properties, the change array entries
+ * should have the new names of the fields as array indexes.
+ *
+ * The value of each entry of the array should be set to another associative
+ * array with the properties of the fields to that are meant to be changed as
+ * array entries. These entries should be assigned to the new values of the
+ * respective properties. The properties of the fields should be the same
+ * as defined by the Metabase parser.
+ *
+ * Example
+ * array(
+ * 'name' => 'userlist',
+ * 'add' => array(
+ * 'quota' => array(
+ * 'type' => 'integer',
+ * 'unsigned' => 1
+ * )
+ * ),
+ * 'remove' => array(
+ * 'file_limit' => array(),
+ * 'time_limit' => array()
+ * ),
+ * 'change' => array(
+ * 'name' => array(
+ * 'length' => '20',
+ * 'definition' => array(
+ * 'type' => 'text',
+ * 'length' => 20,
+ * ),
+ * )
+ * ),
+ * 'rename' => array(
+ * 'sex' => array(
+ * 'name' => 'gender',
+ * 'definition' => array(
+ * 'type' => 'text',
+ * 'length' => 1,
+ * 'default' => 'M',
+ * ),
+ * )
+ * )
+ * )
+ *
+ * @param boolean $check indicates whether the function should just check if the DBMS driver
+ * can perform the requested table alterations if the value is true or
+ * actually perform them otherwise.
+ * @return boolean
+ */
+ public function alterTable($name, $changes, $check) {
+ foreach ($changes as $change_name => $change) {
+ switch ($change_name) {
+ case 'add':
+ case 'remove':
+ case 'change':
+ case 'rename':
+ case 'name':
+ break;
+ default:
+ throw new Doctrine_Export_Exception('change type "'.$change_name.'" not yet supported');
+ }
+ }
+
+ if ($check) {
+ return true;
+ }
+
+ $query = '';
+ if (!empty($changes['name'])) {
+ $change_name = $this->conn->quoteIdentifier($changes['name'], true);
+ $query .= 'RENAME TO ' . $change_name;
+ }
+
+ if (!empty($changes['add']) && is_array($changes['add'])) {
+ foreach ($changes['add'] as $field_name => $field) {
+ if ($query) {
+ $query.= ', ';
+ }
+ $query.= 'ADD ' . $this->dbh->getDeclaration($field['type'], $field_name, $field);
+ }
+ }
+
+ if (!empty($changes['remove']) && is_array($changes['remove'])) {
+ foreach ($changes['remove'] as $field_name => $field) {
+ if ($query) {
+ $query.= ', ';
+ }
+ $field_name = $this->conn->quoteIdentifier($field_name, true);
+ $query.= 'DROP ' . $field_name;
+ }
+ }
+
+ $rename = array();
+ if (!empty($changes['rename']) && is_array($changes['rename'])) {
+ foreach ($changes['rename'] as $field_name => $field) {
+ $rename[$field['name']] = $field_name;
+ }
+ }
+
+ if (!empty($changes['change']) && is_array($changes['change'])) {
+ foreach ($changes['change'] as $field_name => $field) {
+ if ($query) {
+ $query.= ', ';
+ }
+ if (isset($rename[$field_name])) {
+ $old_field_name = $rename[$field_name];
+ unset($rename[$field_name]);
+ } else {
+ $old_field_name = $field_name;
+ }
+ $old_field_name = $this->conn->quoteIdentifier($old_field_name, true);
+ $query.= "CHANGE $old_field_name " . $this->dbh->getDeclaration($field['definition']['type'], $field_name, $field['definition']);
+ }
+ }
+
+ if (!empty($rename) && is_array($rename)) {
+ foreach ($rename as $rename_name => $renamed_field) {
+ if ($query) {
+ $query.= ', ';
+ }
+ $field = $changes['rename'][$renamed_field];
+ $renamed_field = $this->conn->quoteIdentifier($renamed_field, true);
+ $query.= 'CHANGE ' . $renamed_field . ' ' . $this->dbh->getDeclaration($field['definition']['type'], $field['name'], $field['definition']);
+ }
+ }
+
+ if (!$query) {
+ return MDB2_OK;
+ }
+
+ $name = $this->conn->quoteIdentifier($name, true);
+ return $this->dbh->query("ALTER TABLE $name $query");
+ }
+ /**
+ * create sequence
+ *
+ * this method has been borrowed from PEAR MDB2 database abstraction layer
+ *
+ * @param string $seq_name name of the sequence to be created
+ * @param string $start start value of the sequence; default is 1
+ * @return mixed MDB2_OK on success, a MDB2 error on failure
+ */
+ public function createSequence($sequence_name, $seqcol_name, $start = 1) {
+ $query = "CREATE TABLE $sequence_name ($seqcol_name INT NOT NULL AUTO_INCREMENT, PRIMARY KEY ($seqcol_name))";
+ $query .= strlen($this->dbh->options['default_table_type']) ? ' TYPE = '.$this->dbh->options['default_table_type'] : '';
+ $res = $this->dbh->query($query);
+
+ if ($start == 1) {
+ return MDB2_OK;
+ }
+
+ $query = "INSERT INTO $sequence_name ($seqcol_name) VALUES (".($start-1).')';
+ $res = $this->dbh->query($query);
+
+ // Handle error
+ $result = $this->dbh->query("DROP TABLE $sequence_name");
+ if (PEAR::isError($result)) {
+ return $this->dbh->raiseError($result, null, null,
+ 'could not drop inconsistent sequence table', __FUNCTION__);
+ }
+
+ return $this->dbh->raiseError($res, null, null,
+ 'could not create sequence table', __FUNCTION__);
+ }
+ /**
+ * Get the stucture of a field into an array
+ *
+ * this method has been borrowed from PEAR MDB2 database abstraction layer
+ *
+ * @author Leoncx
+ * @param string $table name of the table on which the index is to be created
+ * @param string $name name of the index to be created
+ * @param array $definition associative array that defines properties of the index to be created.
+ * Currently, only one property named FIELDS is supported. This property
+ * is also an associative with the names of the index fields as array
+ * indexes. Each entry of this array is set to another type of associative
+ * array that specifies properties of the index that are specific to
+ * each field.
+ *
+ * Currently, only the sorting property is supported. It should be used
+ * to define the sorting direction of the index. It may be set to either
+ * ascending or descending.
+ *
+ * Not all DBMS support index sorting direction configuration. The DBMS
+ * drivers of those that do not support it ignore this property. Use the
+ * function supports() to determine whether the DBMS driver can manage indexes.
+ *
+ * Example
+ * array(
+ * 'fields' => array(
+ * 'user_name' => array(
+ * 'sorting' => 'ascending'
+ * 'length' => 10
+ * ),
+ * 'last_login' => array()
+ * )
+ * )
+ * @throws PDOException
+ * @return void
+ */
+ public function createIndex($table, $name, array $definition) {
+ $table = $table;
+ $name = $this->dbh->getIndexName($name);
+ $query = 'CREATE INDEX ' . $name . ' ON ' . $table;
+ $fields = array();
+ foreach ($definition['fields'] as $field => $fieldinfo) {
+ if (!empty($fieldinfo['length'])) {
+ $fields[] = $field . '(' . $fieldinfo['length'] . ')';
+ } else {
+ $fields[] = $field;
+ }
+ }
+ $query .= ' ('. implode(', ', $fields) . ')';
+ return $this->dbh->query($query);
+ }
+ /**
+ * drop existing index
+ * this method has been borrowed from PEAR MDB2 database abstraction layer
+ *
+ * @param string $table name of table that should be used in method
+ * @param string $name name of the index to be dropped
+ * @return mixed MDB2_OK on success, a MDB2 error on failure
+ */
+ public function dropIndex($table, $name) {
+ $table = $this->conn->quoteIdentifier($table, true);
+ $name = $this->conn->quoteIdentifier($this->dbh->getIndexName($name), true);
+ return $this->dbh->query("DROP INDEX $name ON $table");
+ }
+ /**
+ * dropTable
+ *
+ * @param string $table name of table that should be dropped from the database
+ * @throws PDOException
+ */
+ public function dropTable($table) {
+ $this->dbh->query('DROP TABLE '.$table);
+ }
+}
+?>
diff --git a/tests/ExportMysqlTestCase.php b/tests/ExportMysqlTestCase.php
new file mode 100644
index 000000000..5de81411a
--- /dev/null
+++ b/tests/ExportMysqlTestCase.php
@@ -0,0 +1,7 @@
+<?php
+class Doctrine_Export_Mysql_TestCase {
+ public function testCreateDatabase() {
+
+ }
+}
+?>
diff --git a/tests/UnitTestCase.php b/tests/UnitTestCase.php
index 698fd1a95..9a2e7325f 100644
--- a/tests/UnitTestCase.php
+++ b/tests/UnitTestCase.php
@@ -7,6 +7,8 @@ require_once dirname(__FILE__).'/../lib/Doctrine.php';
//Doctrine::loadAll();
+ini_set('include_path', $_SERVER['DOCUMENT_ROOT']);
+
function __autoload($class) {
Doctrine::autoload($class);
}