SchemaDiffProviderInterface.php 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. /*
  3. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. *
  15. * This software consists of voluntary contributions made by many individuals
  16. * and is licensed under the LGPL. For more information, see
  17. * <http://www.doctrine-project.org>.
  18. */
  19. namespace Doctrine\DBAL\Migrations\Provider;
  20. use Doctrine\DBAL\Schema\Schema;
  21. /**
  22. * Generates `Schema` objects to be passed to the migrations class.
  23. *
  24. * @since 1.3
  25. */
  26. interface SchemaDiffProviderInterface
  27. {
  28. /**
  29. * Create the schema that represent the current state of the database.
  30. *
  31. * @return Schema
  32. */
  33. public function createFromSchema();
  34. /**
  35. * Create the schema that will represent the future state of the database
  36. *
  37. * @param Schema $fromSchema
  38. * @return Schema
  39. */
  40. public function createToSchema(Schema $fromSchema);
  41. /**
  42. * Return an array of sql statement that migrate the database state from the
  43. * fromSchema to the toSchema.
  44. *
  45. * @param Schema $fromSchema
  46. * @param Schema $toSchema
  47. *
  48. * @return string[]
  49. */
  50. public function getSqlDiffToMigrate(Schema $fromSchema, Schema $toSchema);
  51. }