Merge pull request #398 from thePanz/patch-1

Mention the server-version for migrations

Author: goetas

Resources/doc/index.rst

@@ -444,7 +444,23 @@ This ignores the tables, and any named objects such as sequences, on the DBAL le
 Note that if you have multiple connections configured then the ``schema_filter`` configuration
 will need to be placed per-connection.
 
+Troubleshooting out of sync metadata storage issue
+--------------------------------------------------
+``doctrine/migrations`` relies on a properly configured Database server version in the connection string to manage the table storing the
+migrations, also known as the metadata storage.
+
+If you encounter the error ``The metadata storage is not up to date, please run the sync-metadata-storage command to fix this issue.``
+when running the command ``doctrine:migrations:migrate`` or the suggested command itself ``doctrine:migrations:sync-metadata-storage`` please
+check the database connection string, and make sure that the proper server version is defined. If you are running a MariaDB database,
+you should prefix the server version with ``mariadb-`` (ex: ``mariadb-10.2.12``). See the `configuring_database`_ section.
+
+Example connection string for MariaDB:
+
+.. code-block:: terminal
+    DATABASE_URL=mysql://root:@127.0.0.1:3306/testtest?serverVersion=mariadb-10.4.11
+
 .. _documentation: https://www.doctrine-project.org/projects/doctrine-migrations/en/current/index.html
+.. _configuring_database: https://symfony.com/doc/current/doctrine.html#configuring-the-database
 .. _DoctrineMigrationsBundle: https://github.com/doctrine/DoctrineMigrationsBundle
 .. _`Doctrine Database Migrations`: https://github.com/doctrine/migrations
 .. _`Symfony Flex`: https://symfony.com/doc/current/setup/flex.html