Implement for PgSQL

Author: SOHELAHMED7

src/lib/generators/MigrationsGenerator.php

@@ -12,7 +12,6 @@
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\yii2openapi\lib\items\MigrationModel;
 use cebe\yii2openapi\lib\migrations\BaseMigrationBuilder;
-use cebe\yii2openapi\lib\migrations\MigrationRecordBuilder;
 use cebe\yii2openapi\lib\migrations\MysqlMigrationBuilder;
 use cebe\yii2openapi\lib\migrations\PostgresMigrationBuilder;
 use Exception;
@@ -140,7 +139,7 @@ public function buildMigrations():array
     protected function createBuilder(DbModel $model):BaseMigrationBuilder
     {
         if ($this->db->getDriverName() === 'pgsql') {
-            return Yii::createObject(PostgresMigrationBuilder::class, [$this->db, $model]);
+            return Yii::createObject(PostgresMigrationBuilder::class, [$this->db, $model, $this->config]);
         }
         return Yii::createObject(MysqlMigrationBuilder::class, [$this->db, $model, $this->config]);
     }

src/lib/migrations/BaseMigrationBuilder.php

@@ -10,6 +10,7 @@
 use cebe\yii2openapi\generator\ApiGenerator;
 use cebe\yii2openapi\lib\ColumnToCode;
 use cebe\yii2openapi\lib\Config;
+use cebe\yii2openapi\lib\CustomSpecAttr;
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\yii2openapi\lib\items\ManyToManyRelation;
 use cebe\yii2openapi\lib\items\MigrationModel;
@@ -54,7 +55,7 @@ abstract class BaseMigrationBuilder
      */
     protected $recordBuilder;
 
-    public ?Config $config = null;
+    protected ?Config $config = null;
 
     /**
      * MigrationBuilder constructor.
@@ -597,4 +598,20 @@ public function buildTablesDrop(): void
     abstract public function findPosition(ColumnSchema $column, bool $forDrop = false, bool $forAlter = false): ?string;
 
     abstract public function setColumnsPositions();
+
+    protected function shouldCompareComment(ColumnSchema $desired): bool
+    {
+        $comment = false;
+        if (isset($this->model->attributes[$desired->name]) && $this->model->attributes[$desired->name]->xDescriptionIsComment) {
+            $comment = true;
+        }
+        if ($this->model->descriptionIsComment) {
+            $comment = true;
+        }
+        if ($this->config !== null &&
+            !empty($this->config->getOpenApi()->{CustomSpecAttr::DESC_IS_COMMENT})) {
+            $comment = true;
+        }
+        return $comment;
+    }
 }

src/lib/migrations/MysqlMigrationBuilder.php

@@ -9,7 +9,6 @@
 
 use cebe\yii2openapi\generator\ApiGenerator;
 use cebe\yii2openapi\lib\ColumnToCode;
-use cebe\yii2openapi\lib\CustomSpecAttr;
 use cebe\yii2openapi\lib\items\DbIndex;
 use yii\base\NotSupportedException;
 use yii\db\ColumnSchema;
@@ -62,19 +61,9 @@ protected function compareColumns(ColumnSchema $current, ColumnSchema $desired):
 
         $properties = ['type', 'size', 'allowNull', 'defaultValue', 'enumValues'
             , 'dbType', 'phpType'
-            , 'precision', 'scale', 'unsigned'#, 'comment'
+            , 'precision', 'scale', 'unsigned'
         ];
-        $comment = false;
-        if (isset($this->model->attributes[$desired->name]) && $this->model->attributes[$desired->name]->xDescriptionIsComment) {
-            $comment = true;
-        }
-        if ($this->model->descriptionIsComment) {
-            $comment = true;
-        }
-        if ($this->config && !empty($this->config->getOpenApi()->{CustomSpecAttr::DESC_IS_COMMENT})) {
-            $comment = true;
-        }
-        if ($comment) {
+        if ($this->shouldCompareComment($desired)) {
             $properties[] = 'comment';
         }
         foreach ($properties as $attr) {

src/lib/migrations/PostgresMigrationBuilder.php

@@ -141,10 +141,15 @@ protected function compareColumns(ColumnSchema $current, ColumnSchema $desired):
         $this->modifyDesiredInContextOfCurrent($current, $desiredFromDb);
         $this->modifyDesiredFromDbInContextOfDesired($desired, $desiredFromDb);
 
-        foreach (['type', 'size', 'allowNull', 'defaultValue', 'enumValues'
+        $properties = ['type', 'size', 'allowNull', 'defaultValue', 'enumValues'
                     , 'dbType', 'phpType'
-                     , 'precision', 'scale', 'unsigned', 'comment'
-        ] as $attr) {
+            , 'precision', 'scale', 'unsigned'
+        ];
+        if ($this->shouldCompareComment($desired)) {
+            $properties[] = 'comment';
+        }
+
+        foreach ($properties as $attr) {
             if ($attr === 'defaultValue') {
                 if ($this->isDefaultValueChanged($current, $desiredFromDb)) {
                     $changedAttributes[] = $attr;

tests/specs/blog_v2/migrations_pgsql_db/m200000_000000_change_table_v2_posts.php

@@ -13,17 +13,13 @@ public function safeUp()
         $this->dropIndex('v2_posts_slug_key', '{{%v2_posts}}');
         $this->dropColumn('{{%v2_posts}}', 'uid');
         $this->alterColumn('{{%v2_posts}}', 'category_id', 'int8 NOT NULL USING "category_id"::int8');
-        $this->addCommentOnColumn('{{%v2_posts}}', 'category_id', 'Category of posts');
         $this->alterColumn('{{%v2_posts}}', 'active', "DROP DEFAULT");
         $this->alterColumn('{{%v2_posts}}', 'created_by_id', 'int8 NULL USING "created_by_id"::int8');
-        $this->addCommentOnColumn('{{%v2_posts}}', 'created_by_id', 'The User');
     }
 
     public function safeDown()
     {
-        $this->dropCommentFromColumn('{{%v2_posts}}', 'created_by_id');
         $this->alterColumn('{{%v2_posts}}', 'created_by_id', 'int4 NULL USING "created_by_id"::int4');
-        $this->dropCommentFromColumn('{{%v2_posts}}', 'category_id');
         $this->alterColumn('{{%v2_posts}}', 'category_id', 'int4 NOT NULL USING "category_id"::int4');
         $this->addColumn('{{%v2_posts}}', 'uid', $this->bigInteger()->notNull());
         $this->createIndex('v2_posts_slug_key', '{{%v2_posts}}', 'slug', true);

tests/specs/blog_v2/migrations_pgsql_db/m200000_000005_change_table_v2_comments.php

@@ -11,7 +11,6 @@ public function safeUp()
         $this->dropForeignKey('fk_v2_comments_post_id_v2_posts_uid', '{{%v2_comments}}');
         $this->addColumn('{{%v2_comments}}', 'user_id', $this->bigInteger()->null()->defaultValue(null)->comment('The User'));
         $this->dropColumn('{{%v2_comments}}', 'author_id');
-        $this->addCommentOnColumn('{{%v2_comments}}', 'post_id', 'A blog post (uid used as pk for test purposes)');
         $this->alterColumn('{{%v2_comments}}', 'message', 'text NOT NULL USING "message"::text');
         $this->alterColumn('{{%v2_comments}}', 'message', "DROP DEFAULT");
         $this->alterColumn('{{%v2_comments}}', 'meta_data', 'varchar(300) NULL USING "meta_data"::varchar');
@@ -29,7 +28,6 @@ public function safeDown()
         $this->alterColumn('{{%v2_comments}}', 'created_at', 'int4 NOT NULL USING "created_at"::int4');
         $this->alterColumn('{{%v2_comments}}', 'meta_data', 'jsonb NOT NULL USING "meta_data"::jsonb');
         $this->alterColumn('{{%v2_comments}}', 'message', 'jsonb NOT NULL USING "message"::jsonb');
-        $this->dropCommentFromColumn('{{%v2_comments}}', 'post_id');
         $this->addColumn('{{%v2_comments}}', 'author_id', $this->integer()->notNull());
         $this->dropColumn('{{%v2_comments}}', 'user_id');
         $this->alterColumn('{{%v2_comments}}', 'message', "SET DEFAULT '[]'");