Skip to content

Commit

Permalink
Fixed docs for required params in the configuration
Browse files Browse the repository at this point in the history
It looks like `migrations_namespace` and `migrations_directory` are
mandatory to use any commands. Otherwise we are getting exception.
  • Loading branch information
michalbundyra authored and alcaeus committed Jul 30, 2019
1 parent ebe6f89 commit 91bda6f
Showing 1 changed file with 23 additions and 23 deletions.
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

0 comments on commit 91bda6f

Please sign in to comment.