From 9a2203b5fe7efd04634feabf67f36f61575c76ea Mon Sep 17 00:00:00 2001 From: Mark Story Date: Mon, 4 Nov 2024 12:11:40 -0500 Subject: [PATCH] Update documentation on backend status. (#763) Fixes #762 --- docs/en/upgrading-to-builtin-backend.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/en/upgrading-to-builtin-backend.rst b/docs/en/upgrading-to-builtin-backend.rst index 4731cc22..b1837263 100644 --- a/docs/en/upgrading-to-builtin-backend.rst +++ b/docs/en/upgrading-to-builtin-backend.rst @@ -2,7 +2,8 @@ Upgrading to the builtin backend ################################ As of migrations 4.3 there is a new migrations backend that uses CakePHP's -database abstractions and ORM. Longer term this will allow for phinx to be +database abstractions and ORM. In 4.4, the ``builtin`` backend became the +default backend. Longer term this will allow for phinx to be removed as a dependency. This greatly reduces the dependency footprint of migrations. @@ -42,16 +43,16 @@ Similar changes are for fetching a single row:: $stmt = $this->getAdapter()->query('SELECT * FROM articles'); $rows = $stmt->fetch('assoc'); -Enabling the new backend -======================== +Problems with the new backend? +============================== -The new backend can be enabled through application configuration. Add the +The new backend is enabled by default. If your migrations contain errors when +run with the builtin backend, please open `an issue +`_. You can also switch back +to the ``phinx`` backend through application configuration. Add the following to your ``config/app.php``:: return [ // Other configuration. - 'Migrations' => ['backend' => 'builtin'], + 'Migrations' => ['backend' => 'phinx'], ]; - -If your migrations have problems running with the builtin backend, removing this -configuration option will revert to using phinx.