SchemaSynchronizer.php 2.89 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 23 24 25 26 27 28 29 30 31 32
<?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 MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Schema\Synchronizer;

use Doctrine\DBAL\Schema\Schema;

/**
 * The synchronizer knows how to synchronize a schema with the configured
 * database.
 *
 * @author Benjamin Eberlei <kontakt@beberlei.de>
 */
interface SchemaSynchronizer
{
    /**
Benjamin Morel's avatar
Benjamin Morel committed
33 34 35
     * Gets the SQL statements that can be executed to create the schema.
     *
     * @param \Doctrine\DBAL\Schema\Schema $createSchema
36 37 38 39 40 41
     *
     * @return array
     */
    function getCreateSchema(Schema $createSchema);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
42 43 44 45
     * Gets the SQL Statements to update given schema with the underlying db.
     *
     * @param \Doctrine\DBAL\Schema\Schema $toSchema
     * @param boolean                      $noDrops
46 47 48 49 50 51
     *
     * @return array
     */
    function getUpdateSchema(Schema $toSchema, $noDrops = false);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
52 53 54
     * Gets the SQL Statements to drop the given schema from underlying db.
     *
     * @param \Doctrine\DBAL\Schema\Schema $dropSchema
55 56 57 58 59 60
     *
     * @return array
     */
    function getDropSchema(Schema $dropSchema);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
61
     * Gets the SQL statements to drop all schema assets from underlying db.
62 63 64 65 66 67
     *
     * @return array
     */
    function getDropAllSchema();

    /**
Benjamin Morel's avatar
Benjamin Morel committed
68 69 70
     * Creates the Schema.
     *
     * @param \Doctrine\DBAL\Schema\Schema $createSchema
71 72 73 74 75 76
     *
     * @return void
     */
    function createSchema(Schema $createSchema);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
77 78 79 80
     * Updates the Schema to new schema version.
     *
     * @param \Doctrine\DBAL\Schema\Schema $toSchema
     * @param boolean                      $noDrops
81 82 83 84 85 86
     *
     * @return void
     */
    function updateSchema(Schema $toSchema, $noDrops = false);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
87 88 89
     * Drops the given database schema from the underlying db.
     *
     * @param \Doctrine\DBAL\Schema\Schema $dropSchema
90 91 92 93 94 95
     *
     * @return void
     */
    function dropSchema(Schema $dropSchema);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
96
     * Drops all assets from the underlying db.
97 98 99 100 101
     *
     * @return void
     */
    function dropAllSchema();
}