feat: create SchedulerStore migration with job attributes and comments

Author: arodu

Diff for: config/Migrations/20241206202437_CreateSchedulerStore.php

@@ -2,7 +2,6 @@
 declare(strict_types=1);
 
 use Migrations\AbstractMigration;
-use Phinx\Db\Action\AddColumn;
 
 class CreateSchedulerStore extends AbstractMigration
 {
@@ -11,6 +10,7 @@ class CreateSchedulerStore extends AbstractMigration
      *
      * More information on this method is available here:
      * https://book.cakephp.org/phinx/0/en/migrations.html#the-change-method
+     *
      * @return void
      */
     public function change(): void
@@ -20,34 +20,41 @@ public function change(): void
             'default' => null,
             'limit' => 255,
             'null' => false,
+            'comment' => 'Name of the job',
         ]);
         $table->addColumn('interval_job', 'string', [
             'default' => null,
             'limit' => 255,
             'null' => false,
+            'comment' => 'Interval of the job',
         ]);
         $table->addColumn('task', 'string', [
             'default' => null,
             'limit' => 255,
             'null' => false,
+            'comment' => 'Task to run, src/Job/Service/*',
         ]);
         $table->addColumn('pass', 'string', [
             'default' => null,
             'limit' => 255,
-            'null' => false,
+            'null' => true,
+            'comment' => 'Parameters to pass to the task',
         ]);
         $table->addColumn('lastRun', 'datetime', [
             'default' => null,
             'null' => false,
+            'comment' => 'Last time the job was run',
         ]);
         $table->addColumn('lastResult', 'integer', [
             'default' => 0,
             'limit' => 1,
             'null' => false,
+            'comment' => 'Last result of the job, 0 = success, 1 = failure',
         ]);
         $table->AddColumn('paused', 'boolean', [
             'default' => false,
             'null' => false,
+            'comment' => 'Is the job paused',
         ]);
         $table->create();
     }