Add migration commands description to documentation

Author: Composite PHP

doc/migrations.md

@@ -2,9 +2,9 @@
 
 > **_NOTE:_**  This is experimental feature
 
-Migrations enable you to maintain your database schema within your PHP entity classes. 
-Any modification made in your class triggers the generation of migration files. 
-These files execute SQL queries which synchronize the schema from the PHP class to the corresponding SQL table. 
+Migrations enable you to maintain your database schema within your PHP entity classes.
+Any modification made in your class triggers the generation of migration files.
+These files execute SQL queries which synchronize the schema from the PHP class to the corresponding SQL table.
 This mechanism ensures consistent alignment between your codebase and the database structure.
 
 ## Supported Databases
@@ -26,6 +26,9 @@ You need to configure ConnectionManager, see instructions [here](configuration.m
 ### 3. Configure commands
 
 Add [symfony/console](https://symfony.com/doc/current/components/console.html) commands to your application:
+- Composite\Sync\Commands\MigrateCommand
+- Composite\Sync\Commands\MigrateNewCommand
+- Composite\Sync\Commands\MigrateDownCommand
 - Composite\Sync\Commands\GenerateEntityCommand
 - Composite\Sync\Commands\GenerateTableCommand
 
@@ -40,16 +43,78 @@ use Symfony\Component\Console\Application;
 
 //may be changed with .env file
 putenv('CONNECTIONS_CONFIG_FILE=/path/to/your/connections/config.php');
+putenv('ENTITIES_DIR=/path/to/your/source/dir'); // e.g. "./src"
+putenv('MIGRATIONS_DIR=/path/to/your/migrations/dir'); // e.g. "./src/Migrations"
+putenv('MIGRATIONS_NAMESPACE=Migrations\Namespace'); // e.g. "App\Migrations"
 
 $app = new Application();
 $app->addCommands([
+     new Commands\MigrateCommand(),
+     new Commands\MigrateNewCommand(),
+     new Commands\MigrateDownCommand(),
      new Commands\GenerateEntityCommand(),
      new Commands\GenerateTableCommand(),
 ]);
 $app->run();
 ```
 ## Available commands
 
+* ### composite:migrate
+
+This command performs two primary functions depending on its usage context. Initially, when called for the first time,
+it scans all entities located in the `ENTITIES_DIR` directory and generates migration files corresponding to these entities.
+This initial step prepares the necessary migration scripts based on the current entity definitions. Upon its second
+invocation, the command shifts its role to apply these generated migration scripts to the database. This two-step process
+ensures that the database schema is synchronized with the entity definitions, first by preparing the migration scripts
+and then by executing them to update the database.
+
+```shell
+php cli.php composite:migrate
+```
+
+| Option       | Short | Description                                               |
+|--------------|-------|-----------------------------------------------------------|
+| --connection | -c    | Check migrations for all entities with desired connection |
+| --entity     | -e    | Check migrations only for entity class                    |
+| --run        | -r    | Run migrations without asking for confirmation            |
+| --dry        | -d    | Dry run mode, no real SQL queries will be executed        |
+
+* ### composite:migrate-new
+
+This command generates a new, empty migration file. The file is provided as a template for the user to fill with the
+necessary database schema changes or updates. This command is typically used for initiating a new database migration,
+where the user can define the specific changes to be applied to the database schema. The generated file needs to be
+manually edited to include the desired migration logic before it can be executed with the migration commands.
+
+```shell
+php cli.php composite:migrate-new
+```
+
+| Argument    | Required | Description                              |
+|-------------|----------|------------------------------------------|
+| connection  | No       | Name of connection from your config file |
+| description | No       | Short description of desired changes     |
+
+* ### composite:migrate-down
+
+This command rolls back the most recently applied migration. It is useful for undoing the last schema change made to
+the database. This can be particularly helpful during development or testing phases, where you might need to revert
+recent changes quickly.
+
+```shell
+php cli.php composite:migrate-down
+```
+
+| Argument   | Required | Description                                                               |
+|------------|----------|---------------------------------------------------------------------------|
+| connection | No       | Name of connection from your config file                                  |
+| limit      | No       | Number of migrations should be rolled back from current state, default: 1 |
+
+
+| Option | Short | Description                                         |
+|--------|-------|-----------------------------------------------------|
+| --dry  | -d    | Dry run mode, no real SQL queries will be executed  |
+
 * ### composite:generate-entity
 
 The command examines the specific SQL table and generates an [Composite\Entity\AbstractEntity](https://github.com/compositephp/entity) PHP class.
@@ -67,9 +132,9 @@ php cli.php composite:generate-entity connection_name TableName 'App\Models\Enti
 
 Options:
 
-| Option  | Description             |
-|---------|-------------------------|
-| --force | Overwrite existing file |
+| Option  | Short | Description             |
+|---------|-------|-------------------------|
+| --force | -f    | Overwrite existing file |
 
 * ### composite:generate-table
 
@@ -87,7 +152,7 @@ php cli.php composite:generate-table 'App\Models\EntityName'
 
 Options:
 
-| Option   | Description                                |
-|----------|--------------------------------------------|
-| --cached | Generate cached version of PHP Table class |
-| --force  | Overwrite existing file                    |
+| Option   | Short | Description                                |
+|----------|-------|--------------------------------------------|
+| --cached | -c    | Generate cached version of PHP Table class |
+| --force  | -f    | Overwrite existing file                    |