Skip to content

docs: improve migration.rst #6268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 2 commits into from
Jul 15, 2022
Merged

docs: improve migration.rst #6268

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
148ab57
docs: make section title linkable
kenjis Jul 14, 2022
83b49b5
docs: fix link to Spark commands page
kenjis Jul 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions user_guide_src/source/dbmgmt/migration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,13 @@ to update the schema:
*******************
Command-Line Tools
*******************
CodeIgniter ships with several :doc:`commands </cli/cli_commands>` that are available from the command line to help

CodeIgniter ships with several :doc:`commands </cli/spark_commands>` that are available from the command line to help
you work with migrations. These tools are not required to use migrations but might make things easier for those of you
that wish to use them. The tools primarily provide access to the same methods that are available within the MigrationRunner class.

**migrate**
migrate
=======

Migrates a database group with all available migrations::

Expand All @@ -132,7 +134,8 @@ When using the ``--all`` option, it will scan through all namespaces attempting
not been run. These will all be collected and then sorted as a group by date created. This should help
to minimize any potential conflicts between the main application and any modules.

**rollback**
rollback
========

Rolls back all migrations, taking the database group to a blank slate, effectively migration 0::

Expand All @@ -144,7 +147,8 @@ You can use (rollback) with the following options:
- ``-b`` - to choose a batch: natural numbers specify the batch, negatives indicate a relative batch
- ``-f`` - to force a bypass confirmation question, it is only asked in a production environment

**refresh**
refresh
=======

Refreshes the database state by first rolling back all migrations, and then migrating all::

Expand All @@ -157,7 +161,8 @@ You can use (refresh) with the following options:
- ``--all`` - to refresh all namespaces
- ``-f`` - to force a bypass confirmation question, it is only asked in a production environment

**status**
status
======

Displays a list of all migrations and the date and time they ran, or '--' if they have not been run::

Expand All @@ -174,7 +179,8 @@ You can use (status) with the following options:

- ``-g`` - to choose database group, otherwise default database group will be used.

**make:migration**
make:migration
==============

Creates a skeleton migration file in **app/Database/Migrations**.
It automatically prepends the current timestamp. The class name it
Expand Down