1
0
mirror of synced 2024-12-15 07:36:03 +03:00
doctrine2/lib/Doctrine/DBAL/Schema/AbstractSchemaManager.php

1043 lines
36 KiB
PHP
Raw Normal View History

2008-08-09 13:45:28 +04:00
<?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.doctrine-project.org>.
2008-08-09 13:45:28 +04:00
*/
namespace Doctrine\DBAL\Schema;
2008-08-09 13:45:28 +04:00
use \Doctrine\DBAL\Types;
use \Doctrine\Common\DoctrineException;
2008-08-09 13:45:28 +04:00
/**
* Base class for schema managers. Schema managers are used to inspect and/or
* modify the database schema/structure.
2008-08-09 13:45:28 +04:00
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @author Roman Borschel <roman@code-factory.org>
* @author Jonathan H. Wage <jonwage@gmail.com>
* @author Benjamin Eberlei <kontakt@beberlei.de>
2008-08-09 13:45:28 +04:00
* @version $Revision$
* @since 2.0
*/
abstract class AbstractSchemaManager
2008-08-09 13:45:28 +04:00
{
/**
* Holds instance of the Doctrine connection for this schema manager
*
* @var object \Doctrine\DBAL\Connection
*/
2008-08-09 13:45:28 +04:00
protected $_conn;
/**
* Holds instance of the database platform used for this schema manager
*
* @var string
*/
protected $_platform;
/**
* Constructor. Accepts the Connection instance to manage the schema for
*
* @param \Doctrine\DBAL\Connection $conn
*/
public function __construct(\Doctrine\DBAL\Connection $conn)
{
$this->_conn = $conn;
$this->_platform = $this->_conn->getDatabasePlatform();
}
/**
* Try any method on the schema manager. Normally a method throws an
* exception when your DBMS doesn't support it or if an error occurs.
* This method allows you to try and method on your SchemaManager
* instance and will return false if it does not work or is not supported.
*
* <code>
* $result = $sm->tryMethod('dropView', 'view_name');
* </code>
*
* @return mixed
*/
public function tryMethod()
{
$args = func_get_args();
$method = $args[0];
unset($args[0]);
$args = array_values($args);
try {
return call_user_func_array(array($this, $method), $args);
} catch (\Exception $e) {
return false;
}
}
/* list*() Methods */
2008-08-09 13:45:28 +04:00
/**
* List the available databases for this connection
2008-08-09 13:45:28 +04:00
*
* @return array $databases
2008-08-09 13:45:28 +04:00
*/
public function listDatabases()
{
$sql = $this->_platform->getListDatabasesSql();
$databases = $this->_conn->fetchAll($sql);
return $this->_getPortableDatabasesList($databases);
2008-08-09 13:45:28 +04:00
}
/**
* List the names of available functions for this connection
2008-08-09 13:45:28 +04:00
*
* @example array(
* 'functionA', 'functionB', 'procedureA',
* )
* @return array $functions
2008-08-09 13:45:28 +04:00
*/
public function listFunctions()
{
$sql = $this->_platform->getListFunctionsSql();
$functions = $this->_conn->fetchAll($sql);
return $this->_getPortableFunctionsList($functions);
2008-08-09 13:45:28 +04:00
}
/**
* List the names of available triggers for this connection
2008-08-09 13:45:28 +04:00
*
* @example array(
* 'triggerName1', 'triggerName2',
* );
* @return array $triggers
2008-08-09 13:45:28 +04:00
*/
public function listTriggers()
2008-08-09 13:45:28 +04:00
{
$sql = $this->_platform->getListTriggersSql();
$triggers = $this->_conn->fetchAll($sql);
return $this->_getPortableTriggersList($triggers);
2008-08-09 13:45:28 +04:00
}
/**
* List the available sequences for this connection
2008-08-09 13:45:28 +04:00
*
* @return array $sequences
2008-08-09 13:45:28 +04:00
*/
public function listSequences($database = null)
2008-08-09 13:45:28 +04:00
{
if (is_null($database)) {
$database = $this->_conn->getDatabase();
}
$sql = $this->_platform->getListSequencesSql($database);
$sequences = $this->_conn->fetchAll($sql);
return $this->_getPortableSequencesList($sequences);
2008-08-09 13:45:28 +04:00
}
/**
* List the constraints for a given table
2008-08-09 13:45:28 +04:00
*
* @param string $table The name of the table
* @return array $tableConstraints
2008-08-09 13:45:28 +04:00
*/
public function listTableConstraints($table)
{
$sql = $this->_platform->getListTableConstraintsSql($table);
$tableConstraints = $this->_conn->fetchAll($sql);
return $this->_getPortableTableConstraintsList($tableConstraints);
2008-08-09 13:45:28 +04:00
}
/**
2009-08-21 22:13:22 +04:00
* List the columns for a given table.
2008-08-09 13:45:28 +04:00
*
* @example array(
* 'colA' => array(
* 'name' => 'colA',
* 'type' => \Doctrine\DBAL\Types\StringType instance,
* 'length' => 255,
* 'precision' => null,
* 'scale' => null,
* 'unsigned' => false,
* 'fixed' => false,
* 'notnull' => false,
* 'default' => null,
* 'platformDetails' => array(),
* ),
* );
*
* In contrast to other libraries and to the old version of Doctrine,
* this column definition does try to contain the 'primary' field for
* the reason that it is not portable accross different RDBMS. Use
* {@see listTableIndexes($tableName)} to retrieve the primary key
* of a table. We're a RDBMS specifies more details these are held
* in the platformDetails array.
*
2009-08-21 22:13:22 +04:00
* @param string $table The name of the table.
* @return array $tableColumns The column descriptions.
2008-08-09 13:45:28 +04:00
*/
public function listTableColumns($table)
{
$sql = $this->_platform->getListTableColumnsSql($table);
$tableColumns = $this->_conn->fetchAll($sql);
return $this->_getPortableTableColumnList($tableColumns);
2008-08-09 13:45:28 +04:00
}
/**
* List the indexes for a given table
*
* @example
* $indexes = array(
* 'primary' => array(
* 'name' => 'primary',
* 'columns' => array('id'),
* 'unique' => true,
* 'primary' => true,
* ),
* 'fieldUnq' => array(
* 'name' => 'fieldUnq',
* 'columns' => array('foo', 'bar'),
* 'unique' => true,
* 'primary' => false,
* ),
* 'fieldIdx' => array(
* 'name' => 'fieldIdx',
* 'columns' => array('baz'),
* 'unique' => false,
* 'primary' => false,
* ),
* );
2008-08-09 13:45:28 +04:00
*
* @param string $table The name of the table
* @return array $tableIndexes
2008-08-09 13:45:28 +04:00
*/
public function listTableIndexes($table)
{
$sql = $this->_platform->getListTableIndexesSql($table);
$tableIndexes = $this->_conn->fetchAll($sql);
return $this->_getPortableTableIndexesList($tableIndexes, $table);
2008-08-09 13:45:28 +04:00
}
/**
* List the tables for this connection
2008-08-09 13:45:28 +04:00
*
* @return array $tables
2008-08-09 13:45:28 +04:00
*/
public function listTables()
2008-08-09 13:45:28 +04:00
{
$sql = $this->_platform->getListTablesSql();
$tables = $this->_conn->fetchAll($sql);
return $this->_getPortableTablesList($tables);
2008-08-09 13:45:28 +04:00
}
/**
* List the users this connection has
2008-08-09 13:45:28 +04:00
*
* @return array $users
2008-08-09 13:45:28 +04:00
*/
public function listUsers()
{
$sql = $this->_platform->getListUsersSql();
$users = $this->_conn->fetchAll($sql);
return $this->_getPortableUsersList($users);
2008-08-09 13:45:28 +04:00
}
/**
* List the views this connection has
2008-08-09 13:45:28 +04:00
*
* @example array(
* array('name' => 'ViewA', 'sql' => 'SELECT * FROM foo'),
* array('name' => 'ViewB', 'sql' => 'SELECT * FROM bar'),
* )
* @return array $views
2008-08-09 13:45:28 +04:00
*/
public function listViews()
2008-08-09 13:45:28 +04:00
{
$sql = $this->_platform->getListViewsSql();
$views = $this->_conn->fetchAll($sql);
return $this->_getPortableViewsList($views);
2008-08-09 13:45:28 +04:00
}
/**
* List the foreign keys for the given table
*
* @param string $table The name of the table
* @return array $tableForeignKeys
*/
public function listTableForeignKeys($table, $database = null)
{
if (is_null($database)) {
$database = $this->_conn->getDatabase();
}
$sql = $this->_platform->getListTableForeignKeysSql($table, $database);
$tableForeignKeys = $this->_conn->fetchAll($sql);
return $this->_getPortableTableForeignKeysList($tableForeignKeys);
}
/* drop*() Methods */
2008-08-09 13:45:28 +04:00
/**
* Drops a database.
*
* NOTE: You can not drop the database this SchemaManager is currently connected to.
2008-08-09 13:45:28 +04:00
*
* @param string $database The name of the database to drop
2008-08-09 13:45:28 +04:00
*/
public function dropDatabase($database)
2008-08-09 13:45:28 +04:00
{
$this->_execSql($this->_platform->getDropDatabaseSql($database));
2008-08-09 13:45:28 +04:00
}
/**
* Drop the given table
2008-08-09 13:45:28 +04:00
*
* @param string $table The name of the table to drop
2008-08-09 13:45:28 +04:00
*/
public function dropTable($table)
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getDropTableSql($table));
2008-08-09 13:45:28 +04:00
}
/**
* Drop the index from the given table
2008-08-09 13:45:28 +04:00
*
* @param string $table The name of the table
* @param string $name The name of the index
2008-08-09 13:45:28 +04:00
*/
public function dropIndex($table, $name)
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getDropIndexSql($table, $name));
2008-08-09 13:45:28 +04:00
}
/**
* Drop the constraint from the given table
2008-08-09 13:45:28 +04:00
*
* @param string $table The name of the table
* @param string $name The name of the constraint
* @param string $primary Whether or not it is a primary constraint
2008-08-09 13:45:28 +04:00
*/
public function dropConstraint($table, $name, $primary = false)
{
$this->_execSql($this->_platform->getDropConstraintSql($table, $name, $primary));
2008-08-09 13:45:28 +04:00
}
/**
2009-05-30 22:38:00 +04:00
* Drops a foreign key from a table.
2008-08-09 13:45:28 +04:00
*
2009-05-30 22:38:00 +04:00
* @param string $table The name of the table with the foreign key.
* @param string $name The name of the foreign key.
* @return boolean $result
2008-08-09 13:45:28 +04:00
*/
public function dropForeignKey($table, $name)
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getDropForeignKeySql($table, $name));
2008-08-09 13:45:28 +04:00
}
/**
2009-05-30 22:38:00 +04:00
* Drops a sequence with a given name.
2008-08-09 13:45:28 +04:00
*
2009-05-30 22:38:00 +04:00
* @param string $name The name of the sequence to drop.
2008-08-09 13:45:28 +04:00
*/
public function dropSequence($name)
2008-08-09 13:45:28 +04:00
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getDropSequenceSql($name));
2008-08-09 13:45:28 +04:00
}
/**
* Drop a view
*
* @param string $name The name of the view
* @return boolean $result
*/
public function dropView($name)
{
$this->_execSql($this->_platform->getDropViewSql($name));
}
/* create*() Methods */
2008-08-09 13:45:28 +04:00
/**
2009-05-30 22:38:00 +04:00
* Creates a new database.
2008-08-09 13:45:28 +04:00
*
2009-05-30 22:38:00 +04:00
* @param string $database The name of the database to create.
2008-08-09 13:45:28 +04:00
*/
2009-05-30 18:10:01 +04:00
public function createDatabase($database)
2008-08-09 13:45:28 +04:00
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getCreateDatabaseSql($database));
2008-08-09 13:45:28 +04:00
}
/**
2009-05-30 22:38:00 +04:00
* Create a new table.
2008-08-09 13:45:28 +04:00
*
2009-05-30 22:38:00 +04:00
* @param string $name Name of the database that should be created
* @param array $columns Associative array that contains the definition of each field of the new table
2009-05-30 22:38:00 +04:00
* @param array $options An associative array of table options.
2008-08-09 13:45:28 +04:00
*/
public function createTable($name, array $columns, array $options = array())
2008-08-09 13:45:28 +04:00
{
// Build array of the primary keys if any of the individual field definitions
// specify primary => true
$count = 0;
foreach ($columns as $columnName => $definition) {
if (isset($definition['primary']) && $definition['primary']) {
2008-08-09 13:45:28 +04:00
if ($count == 0) {
$options['primary'] = array();
}
++$count;
$options['primary'][] = $columnName;
2008-08-09 13:45:28 +04:00
}
}
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getCreateTableSql($name, $columns, $options));
2008-08-09 13:45:28 +04:00
}
/**
* Create a new sequence
2008-08-09 13:45:28 +04:00
*
* @param string $seqName name of the sequence to be created
* @param string $start start value of the sequence; default is 1
* @param array $allocationSize The size to allocate for sequence
* @throws Doctrine\DBAL\ConnectionException if something fails at database level
2008-08-09 13:45:28 +04:00
*/
2009-05-30 22:38:00 +04:00
public function createSequence($seqName, $start = 1, $allocationSize = 1)
2008-08-09 13:45:28 +04:00
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getCreateSequenceSql($seqName, $start, $allocationSize));
2008-08-09 13:45:28 +04:00
}
/**
* Create a constraint on a table
2008-08-09 13:45:28 +04:00
*
* @param string $table name of the table on which the constraint is to be created
* @param string $name name of the constraint to be created
* @param array $definition associative array that defines properties of the constraint to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the constraint fields as array
* constraints. Each entry of this array is set to another type of associative
* array that specifies properties of the constraint that are specific to
* each field.
*
* Example
* array(
* 'columns' => array(
2008-08-09 13:45:28 +04:00
* 'user_name' => array(),
* 'last_login' => array()
* )
* )
*/
public function createConstraint($table, $name, $definition)
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getCreateConstraintSql($table, $name, $definition));
2008-08-09 13:45:28 +04:00
}
/**
* Create a new index on a table
2008-08-09 13:45:28 +04:00
*
* @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(
* 'columns' => array(
2008-08-09 13:45:28 +04:00
* 'user_name' => array(
* 'sorting' => 'ascending'
* ),
* 'last_login' => array()
* )
* )
*/
public function createIndex($table, $name, array $definition)
{
2009-05-30 22:38:00 +04:00
$this->_execSql($this->_platform->getCreateIndexSql($table, $name, $definition));
2008-08-09 13:45:28 +04:00
}
/**
* Create a new foreign key
2008-08-09 13:45:28 +04:00
*
* @param string $table name of the table on which the foreign key is to be created
* @param array $definition associative array that defines properties of the foreign key to be created.
*/
public function createForeignKey($table, array $definition)
{
$this->_execSql($this->_platform->getCreateForeignKeySql($table, $definition));
2008-08-09 13:45:28 +04:00
}
/**
* Create a new view
*
* @param string $name The name of the view
* @param string $sql The sql to set to the view
*/
public function createView($name, $sql)
{
$this->_execSql($this->_platform->getCreateViewSql($name, $sql));
}
/* dropAndCreate*() Methods */
/**
* Drop and create a constraint
*
* @param string $table name of the table on which the constraint is to be created
* @param string $name name of the constraint to be created
* @param array $definition associative array that defines properties of the constraint to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the constraint fields as array
* constraints. Each entry of this array is set to another type of associative
* array that specifies properties of the constraint that are specific to
* each field.
*
* Example
* array(
* 'columns' => array(
* 'user_name' => array(),
* 'last_login' => array()
* )
* )
* @param boolean $primary Whether or not it is a primary constraint
* @see dropConstraint()
* @see createConstraint()
*/
public function dropAndCreateConstraint($table, $name, $definition, $primary = false)
{
$this->tryMethod('dropConstraint', $table, $name, $primary);
$this->createConstraint($table, $name, $definition);
}
/**
* Drop and create a new index on a table
*
* @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(
* 'columns' => array(
* 'user_name' => array(
* 'sorting' => 'ascending'
* ),
* 'last_login' => array()
* )
* )
*/
public function dropAndCreateIndex($table, $name, array $definition)
{
$this->tryMethod('dropIndex', $table, $name);
$this->createIndex($table, $name, $definition);
}
/**
* Drop and create a new foreign key
*
* @param string $table name of the table on which the foreign key is to be created
* @param array $definition associative array that defines properties of the foreign key to be created.
*/
public function dropAndCreateForeignKey($table, $definition)
{
$this->tryMethod('dropForeignKey', $table, $definition['name']);
$this->createForeignKey($table, $definition);
}
/**
* Drop and create a new sequence
*
* @param string $seqName name of the sequence to be created
* @param string $start start value of the sequence; default is 1
* @param array $allocationSize The size to allocate for sequence
* @throws Doctrine\DBAL\ConnectionException if something fails at database level
*/
public function dropAndCreateSequence($seqName, $start = 1, $allocationSize = 1)
{
$this->tryMethod('createSequence', $seqName, $start, $allocationSize);
$this->createSequence($seqName, $start, $allocationSize);
}
/**
* Drop and create a new table.
*
* @param string $name Name of the database that should be created
* @param array $columns Associative array that contains the definition of each field of the new table
* @param array $options An associative array of table options.
*/
public function dropAndCreateTable($name, array $columns, array $options = array())
{
$this->tryMethod('dropTable', $name);
$this->createTable($name, $columns, $options);
}
/**
* Drop and creates a new database.
*
* @param string $database The name of the database to create.
*/
public function dropAndCreateDatabase($database)
{
$this->tryMethod('dropDatabase', $database);
$this->createDatabase($database);
}
/**
* Drop and create a new view
*
* @param string $name The name of the view
* @param string $sql The sql to set to the view
*/
public function dropAndCreateView($name, $sql)
{
$this->tryMethod('dropView', $name);
$this->createView($name, $sql);
}
/* alterTable() Methods */
2008-08-09 13:45:28 +04:00
/**
* Alter an existing tables schema
2008-08-09 13:45:28 +04:00
*
* @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 MDB2 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 MDB2 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.
*/
public function alterTable($name, array $changes, $check = false)
{
$queries = $this->_platform->getAlterTableSql($name, $changes, $check);
foreach($queries AS $ddlQuery) {
$this->_execSql($ddlQuery);
}
}
/**
* Rename a given table to another name
*
* @param string $name The current name of the table
* @param string $newName The new name of the table
*/
public function renameTable($name, $newName)
{
$change = array(
'name' => $newName
);
2009-05-30 22:38:00 +04:00
$this->alterTable($name, $change);
}
/**
* Add a new table column
*
* @param string $name The name of the table
2009-05-28 06:45:51 +04:00
* @param string $column The name of the column to add
* @param array $definition The definition of the column to add
*/
2009-05-28 06:45:51 +04:00
public function addTableColumn($name, $column, $definition)
{
$change = array(
'add' => array(
2009-05-28 06:45:51 +04:00
$column => $definition
)
);
2009-05-30 22:38:00 +04:00
$this->alterTable($name, $change);
}
/**
* Remove a column from a table
*
* @param string $tableName The name of the table
* @param array|string $column The column name or array of names
*/
public function removeTableColumn($name, $column)
{
$change = array(
'remove' => is_array($column) ? $column : array($column => array())
);
2009-05-30 22:38:00 +04:00
$this->alterTable($name, $change);
}
/**
* Change a given table column. You can change the type, length, etc.
*
* @param string $name The name of the table
* @param string $type The type of the column
* @param string $length The length of the column
* @param string $definition The definition array for the column
*/
public function changeTableColumn($name, $type, $length = null, $definition = array())
{
$definition['type'] = $type;
$change = array(
'change' => array(
$name => array(
'length' => $length,
'definition' => $definition
)
)
);
2009-05-30 22:38:00 +04:00
$this->alterTable($name, $change);
}
/**
* Rename a given table column
*
* @param string $name The name of the table
* @param string $oldName The old column name
* @param string $newName The new column
* @param string $definition The column definition array if you want to change something
*/
public function renameTableColumn($name, $oldName, $newName, $definition = array())
{
$change = array(
'rename' => array(
$oldName => array(
'name' => $newName,
'definition' => $definition
)
)
);
2009-05-30 22:38:00 +04:00
$this->alterTable($name, $change);
}
/**
* Methods for filtering return values of list*() methods to convert
* the native DBMS data definition to a portable Doctrine definition
*/
protected function _getPortableDatabasesList($databases)
{
$list = array();
foreach ($databases as $key => $value) {
if ($value = $this->_getPortableDatabaseDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableDatabaseDefinition($database)
{
return $database;
}
protected function _getPortableFunctionsList($functions)
{
$list = array();
foreach ($functions as $key => $value) {
if ($value = $this->_getPortableFunctionDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableFunctionDefinition($function)
{
return $function;
}
protected function _getPortableTriggersList($triggers)
{
$list = array();
foreach ($triggers as $key => $value) {
if ($value = $this->_getPortableTriggerDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableTriggerDefinition($trigger)
{
return $trigger;
}
protected function _getPortableSequencesList($sequences)
{
$list = array();
foreach ($sequences as $key => $value) {
if ($value = $this->_getPortableSequenceDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableSequenceDefinition($sequence)
{
return $sequence;
}
protected function _getPortableTableConstraintsList($tableConstraints)
{
$list = array();
foreach ($tableConstraints as $key => $value) {
if ($value = $this->_getPortableTableConstraintDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableTableConstraintDefinition($tableConstraint)
{
return $tableConstraint;
}
protected function _getPortableTableColumnList($tableColumns)
{
$list = array();
foreach ($tableColumns as $key => $value) {
if ($value = $this->_getPortableTableColumnDefinition($value)) {
if (is_string($value['type'])) {
$value['type'] = \Doctrine\DBAL\Types\Type::getType($value['type']);
}
$list[$value['name']] = $value;
}
}
return $list;
}
protected function _getPortableTableColumnDefinition($tableColumn)
{
return $tableColumn;
}
/**
* Aggregate and group the index results according to the required data result.
*
* @param array $tableIndexes
* @param string $tableName
* @return array
*/
protected function _getPortableTableIndexesList($tableIndexes, $tableName=null)
{
$result = array();
foreach($tableIndexes AS $tableIndex) {
$indexName = $keyName = $tableIndex['key_name'];
if($tableIndex['primary']) {
$keyName = 'primary';
}
if(!isset($result[$keyName])) {
$result[$keyName] = array(
'name' => $indexName,
'columns' => array($tableIndex['column_name']),
'unique' => $tableIndex['non_unique'] ? false : true,
'primary' => $tableIndex['primary'],
);
} else {
$result[$keyName]['columns'][] = $tableIndex['column_name'];
}
}
return $result;
}
protected function _getPortableTablesList($tables)
{
$list = array();
foreach ($tables as $key => $value) {
if ($value = $this->_getPortableTableDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableTableDefinition($table)
{
return $table;
}
protected function _getPortableUsersList($users)
{
$list = array();
foreach ($users as $key => $value) {
if ($value = $this->_getPortableUserDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableUserDefinition($user)
{
return $user;
}
protected function _getPortableViewsList($views)
{
$list = array();
foreach ($views as $key => $value) {
if ($value = $this->_getPortableViewDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableViewDefinition($view)
{
return $view;
}
protected function _getPortableTableForeignKeysList($tableForeignKeys)
{
$list = array();
foreach ($tableForeignKeys as $key => $value) {
if ($value = $this->_getPortableTableForeignKeyDefinition($value)) {
$list[] = $value;
}
}
return $list;
}
protected function _getPortableTableForeignKeyDefinition($tableForeignKey)
{
return $tableForeignKey;
}
2009-05-30 18:10:01 +04:00
protected function _execSql($sql)
{
foreach ((array) $sql as $query) {
$this->_conn->executeUpdate($query);
2008-08-09 13:45:28 +04:00
}
}
}