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.

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

Fixed docs for required params in the configuration #842

Merged
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -90,29 +90,29 @@ 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 |
+============================+============+============================+==================================================================================+
| name | no | Doctrine Migrations | The name that shows at the top of the migrations console application. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
| migrations_namespace | no | null | The PHP namespace your migration classes are located under. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
| table_name | no | doctrine_migration_versions| The name of the table to track executed migrations in. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
| column_name | no | version | The name of the column which stores the version name. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
| column_length | no | 14 | 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. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
| migrations_directory | no | null | The path to a directory where to look for migration classes. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
| all_or_nothing | no | false | Whether or not to wrap multiple 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. |
+----------------------------+------------+----------------------------+----------------------------------------------------------------------------------+
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| Name | Required | Default | Description |
+============================+=============+============================+==================================================================================+
| name | no | Doctrine Migrations | The name that shows at the top of the migrations console application. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| migrations_namespace | yes | null | The PHP namespace your migration classes are located under. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| table_name | no | doctrine_migration_versions| The name of the table to track executed migrations in. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| column_name | no | version | The name of the column which stores the version name. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| column_length | no | 14 | 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. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| migrations_directory | yes | null | The path to a directory where to look for migration classes. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+
| all_or_nothing | no | false | Whether or not to wrap multiple 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. |
+----------------------------+-------------+----------------------------+----------------------------------------------------------------------------------+

Manually Providing Migrations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down