Schema.php 10.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<?php
/*
 * 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>.
 */

namespace Doctrine\DBAL\Schema;

use Doctrine\DBAL\Schema\Visitor\CreateSchemaSqlCollector;
23 24
use Doctrine\DBAL\Schema\Visitor\DropSchemaSqlCollector;
use Doctrine\DBAL\Schema\Visitor\Visitor;
25 26 27 28

/**
 * Object representation of a database schema
 *
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
 * Different vendors have very inconsistent naming with regard to the concept
 * of a "schema". Doctrine understands a schema as the entity that conceptually
 * wraps a set of database objects such as tables, sequences, indexes and
 * foreign keys that belong to each other into a namespace. A Doctrine Schema
 * has nothing to do with the "SCHEMA" defined as in PostgreSQL, it is more
 * related to the concept of "DATABASE" that exists in MySQL and PostgreSQL.
 *
 * Every asset in the doctrine schema has a name. A name consists of either a
 * namespace.local name pair or just a local unqualified name.
 *
 * The abstraction layer that covers a PostgreSQL schema is the namespace of an
 * database object (asset). A schema can have a name, which will be used as
 * default namespace for the unqualified database objects that are created in
 * the schema.
 *
 * In the case of MySQL where cross-database queries are allowed this leads to
 * databases being "misinterpreted" as namespaces. This is intentional, however
 * the CREATE/DROP SQL visitors will just filter this queries and do not
 * execute them. Only the queries for the currently connected database are
 * executed.
 *
50 51 52 53 54 55 56 57 58 59 60
 * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link    www.doctrine-project.org
 * @since   2.0
 * @author  Benjamin Eberlei <kontakt@beberlei.de>
 */
class Schema extends AbstractAsset
{
    /**
     * @var array
     */
    protected $_tables = array();
61

62 63 64 65 66
    /**
     * @var array
     */
    protected $_sequences = array();

67
    /**
68
     * @var SchemaConfig
69
     */
70
    protected $_schemaConfig = false;
71

72 73 74
    /**
     * @param array $tables
     * @param array $sequences
75 76
     * @param array $views
     * @param array $triggers
77
     * @param SchemaConfig $schemaConfig
78
     */
79
    public function __construct(array $tables=array(), array $sequences=array(), SchemaConfig $schemaConfig=null)
80
    {
81 82 83 84
        if ($schemaConfig == null) {
            $schemaConfig = new SchemaConfig();
        }
        $this->_schemaConfig = $schemaConfig;
85
        $this->_setName($schemaConfig->getName() ?: 'public');
86

87 88 89 90 91 92
        foreach ($tables AS $table) {
            $this->_addTable($table);
        }
        foreach ($sequences AS $sequence) {
            $this->_addSequence($sequence);
        }
93 94 95 96 97 98 99
    }

    /**
     * @return bool
     */
    public function hasExplicitForeignKeyIndexes()
    {
100
        return $this->_schemaConfig->hasExplicitForeignKeyIndexes();
101 102 103 104 105 106 107
    }

    /**
     * @param Table $table
     */
    protected function _addTable(Table $table)
    {
108
        $tableName = $table->getFullQualifiedName($this->getName());
109 110 111 112 113
        if(isset($this->_tables[$tableName])) {
            throw SchemaException::tableAlreadyExists($tableName);
        }

        $this->_tables[$tableName] = $table;
114
        $table->setSchemaConfig($this->_schemaConfig);
115 116 117 118 119 120 121
    }

    /**
     * @param Sequence $sequence
     */
    protected function _addSequence(Sequence $sequence)
    {
122
        $seqName = $sequence->getFullQualifiedName($this->getName());
123 124 125 126 127 128 129 130
        if (isset($this->_sequences[$seqName])) {
            throw SchemaException::sequenceAlreadyExists($seqName);
        }
        $this->_sequences[$seqName] = $sequence;
    }

    /**
     * Get all tables of this schema.
131
     *
132 133 134 135 136 137 138 139 140 141 142 143 144
     * @return array
     */
    public function getTables()
    {
        return $this->_tables;
    }

    /**
     * @param string $tableName
     * @return Table
     */
    public function getTable($tableName)
    {
145
        $tableName = $this->getFullQualifiedAssetName($tableName);
146 147 148 149 150 151 152
        if (!isset($this->_tables[$tableName])) {
            throw SchemaException::tableDoesNotExist($tableName);
        }

        return $this->_tables[$tableName];
    }

153 154 155 156 157 158 159 160 161 162 163
    /**
     * @return string
     */
    private function getFullQualifiedAssetName($name)
    {
        if (strpos($name, ".") === false) {
            $name = $this->getName() . "." . $name;
        }
        return strtolower($name);
    }

164 165
    /**
     * Does this schema have a table with the given name?
166
     *
167 168 169 170 171
     * @param  string $tableName
     * @return Schema
     */
    public function hasTable($tableName)
    {
172
        $tableName = $this->getFullQualifiedAssetName($tableName);
173 174 175
        return isset($this->_tables[$tableName]);
    }

176 177 178 179 180 181
    /**
     * Get all table names, prefixed with a schema name, even the default one
     * if present.
     *
     * @return array
     */
182
    public function getTableNames()
183
    {
184
        return array_keys($this->_tables);
185 186
    }

187 188
    public function hasSequence($sequenceName)
    {
189
        $sequenceName = $this->getFullQualifiedAssetName($sequenceName);
190 191 192 193 194 195 196 197 198 199
        return isset($this->_sequences[$sequenceName]);
    }

    /**
     * @throws SchemaException
     * @param  string $sequenceName
     * @return Doctrine\DBAL\Schema\Sequence
     */
    public function getSequence($sequenceName)
    {
200
        $sequenceName = $this->getFullQualifiedAssetName($sequenceName);
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
        if(!$this->hasSequence($sequenceName)) {
            throw SchemaException::sequenceDoesNotExist($sequenceName);
        }
        return $this->_sequences[$sequenceName];
    }

    /**
     * @return Doctrine\DBAL\Schema\Sequence[]
     */
    public function getSequences()
    {
        return $this->_sequences;
    }

    /**
     * Create a new table
217
     *
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
     * @param  string $tableName
     * @return Table
     */
    public function createTable($tableName)
    {
        $table = new Table($tableName);
        $this->_addTable($table);
        return $table;
    }

    /**
     * Rename a table
     *
     * @param string $oldTableName
     * @param string $newTableName
     * @return Schema
     */
    public function renameTable($oldTableName, $newTableName)
    {
        $table = $this->getTable($oldTableName);
        $table->_setName($newTableName);

        $this->dropTable($oldTableName);
        $this->_addTable($table);
        return $this;
    }

    /**
     * Drop a table from the schema.
     *
     * @param string $tableName
     * @return Schema
     */
    public function dropTable($tableName)
    {
253
        $tableName = $this->getFullQualifiedAssetName($tableName);
254 255 256 257 258 259 260
        $table = $this->getTable($tableName);
        unset($this->_tables[$tableName]);
        return $this;
    }

    /**
     * Create a new sequence
261
     *
262 263 264
     * @param  string $sequenceName
     * @param  int $allocationSize
     * @param  int $initialValue
265
     * @return Sequence
266 267 268 269 270
     */
    public function createSequence($sequenceName, $allocationSize=1, $initialValue=1)
    {
        $seq = new Sequence($sequenceName, $allocationSize, $initialValue);
        $this->_addSequence($seq);
271
        return $seq;
272 273 274 275 276 277 278 279
    }

    /**
     * @param string $sequenceName
     * @return Schema
     */
    public function dropSequence($sequenceName)
    {
280
        $sequenceName = $this->getFullQualifiedAssetName($sequenceName);
281 282 283 284 285
        unset($this->_sequences[$sequenceName]);
        return $this;
    }

    /**
286 287
     * Return an array of necessary sql queries to create the schema on the given platform.
     *
288
     * @param AbstractPlatform $platform
289
     * @return array
290 291 292 293 294 295 296 297 298
     */
    public function toSql(\Doctrine\DBAL\Platforms\AbstractPlatform $platform)
    {
        $sqlCollector = new CreateSchemaSqlCollector($platform);
        $this->visit($sqlCollector);

        return $sqlCollector->getQueries();
    }

299 300 301 302 303 304 305 306 307 308 309 310 311 312
    /**
     * Return an array of necessary sql queries to drop the schema on the given platform.
     *
     * @param AbstractPlatform $platform
     * @return array
     */
    public function toDropSql(\Doctrine\DBAL\Platforms\AbstractPlatform $platform)
    {
        $dropSqlCollector = new DropSchemaSqlCollector($platform);
        $this->visit($dropSqlCollector);

        return $dropSqlCollector->getQueries();
    }

313
    /**
314
     * @param Schema $toSchema
315 316
     * @param AbstractPlatform $platform
     */
317
    public function getMigrateToSql(Schema $toSchema, \Doctrine\DBAL\Platforms\AbstractPlatform $platform)
318
    {
319
        $comparator = new Comparator();
320 321
        $schemaDiff = $comparator->compare($this, $toSchema);
        return $schemaDiff->toSql($platform);
322 323
    }

324
    /**
325
     * @param Schema $fromSchema
326 327
     * @param AbstractPlatform $platform
     */
328
    public function getMigrateFromSql(Schema $fromSchema, \Doctrine\DBAL\Platforms\AbstractPlatform $platform)
329
    {
330
        $comparator = new Comparator();
331 332
        $schemaDiff = $comparator->compare($fromSchema, $this);
        return $schemaDiff->toSql($platform);
333 334
    }

335 336 337 338 339 340
    /**
     * @param Visitor $visitor
     */
    public function visit(Visitor $visitor)
    {
        $visitor->acceptSchema($this);
341

342 343 344 345 346 347 348
        foreach ($this->_tables AS $table) {
            $table->visit($visitor);
        }
        foreach ($this->_sequences AS $sequence) {
            $sequence->visit($visitor);
        }
    }
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

    /**
     * Cloning a Schema triggers a deep clone of all related assets.
     *
     * @return void
     */
    public function __clone()
    {
        foreach ($this->_tables AS $k => $table) {
            $this->_tables[$k] = clone $table;
        }
        foreach ($this->_sequences AS $k => $sequence) {
            $this->_sequences[$k] = clone $sequence;
        }
    }
364
}