Skip to content
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

Fix tables rendering in configuration.rst #1459

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Fix tables rendering in configuration.rst #1459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 23 additions & 23 deletions docs/en/reference/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,28 +131,27 @@ Please note that if you want to use the YAML configuration option, you will need

Here are details about what each configuration option does:

+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| Name | Required | Default | Description |
+============================+============+==============================+==================================================================================+
| migrations_paths<string, string> | yes | null | The PHP namespace your migration classes are located under and the path to a directory where to look for migration classes. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| table_storage | no | | Used by doctrine migrations to track the currently executed migrations |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| all_or_nothing | no | false | Whether or not to wrap multiple migrations in a single transaction. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| transactional | no | true | Whether or not to wrap migrations in a single transaction. |
| | | | |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| migrations | no | [] | Manually specify the array of migration versions instead of finding migrations. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| check_database_platform | no | true | Whether to add a database platform check at the beginning of the generated code. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| organize_migrations | no | ``none`` | Whether to organize migration classes under year (``year``) or year and month (``year_and_month``) subdirectories. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| connection | no | null | The named connection to use (available only when ConnectionRegistryConnection is used). |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| em | no | null | The named entity manager to use (available only when ManagerRegistryEntityManager is used). |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| Name | Required | Default | Description |
+==================================+==========+==========+=============================================================================================================================+
| migrations_paths<string, string> | yes | null | The PHP namespace your migration classes are located under and the path to a directory where to look for migration classes. |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| table_storage | no | | Used by doctrine migrations to track the currently executed migrations |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| all_or_nothing | no | false | Whether or not to wrap multiple migrations in a single transaction. |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| transactional | no | true | Whether or not to wrap migrations in a single transaction. |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| migrations | no | [] | Manually specify the array of migration versions instead of finding migrations. |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| check_database_platform | no | true | Whether to add a database platform check at the beginning of the generated code. |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| organize_migrations | no | ``none`` | Whether to organize migration classes under year (``year``) or year and month (``year_and_month``) subdirectories. |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| connection | no | null | The named connection to use (available only when ConnectionRegistryConnection is used). |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+
| em | no | null | The named entity manager to use (available only when ManagerRegistryEntityManager is used). |
+----------------------------------+----------+----------+-----------------------------------------------------------------------------------------------------------------------------+


Here the possible options for ``table_storage``:
Expand All @@ -164,7 +163,7 @@ Here the possible options for ``table_storage``:
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| version_column_name | no | version | The name of the column which stores the version name. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| version_column_length | no | 191 | The length of the column which stores the version name. |
| version_column_length | no | 191 | The length of the column which stores the version name. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
| executed_at_column_name | no | executed_at | The name of the column which stores the date that a migration was executed. |
+----------------------------+------------+------------------------------+----------------------------------------------------------------------------------+
Expand Down Expand Up @@ -378,3 +377,4 @@ Make sure to create the directory where your ORM entities will be located:
$ mkdir lib/MyProject/Entities

:ref:`Next Chapter: Migration Classes <migration-classes>`