Skip to content

Commit

Permalink
Update documentation on backend status. (#763)
Browse files Browse the repository at this point in the history
Fixes #762
  • Loading branch information
markstory authored Nov 4, 2024
1 parent 4621df2 commit 9a2203b
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/en/upgrading-to-builtin-backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
<https://github.com/cakephp/migrations/issues/new>`_. 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.

0 comments on commit 9a2203b

Please sign in to comment.