feat: add snowflake column type alias (#235)

Author: puzzledpolymath

psalm-baseline.xml

@@ -884,6 +884,9 @@
     <DocblockTypeContradiction>
       <code><![CDATA[$size < 0]]></code>
     </DocblockTypeContradiction>
+    <InvalidArgument>
+      <code><![CDATA[[parent::class, 'compare']]]></code>
+    </InvalidArgument>
     <InvalidClassConstantType>
       <code><![CDATA[EXCLUDE_FROM_COMPARE]]></code>
     </InvalidClassConstantType>
@@ -900,7 +903,14 @@
       <code><![CDATA[$column->comment]]></code>
       <code><![CDATA[$column->type]]></code>
       <code><![CDATA[$defaultValue]]></code>
+      <code><![CDATA[$result]]></code>
     </MixedAssignment>
+    <MixedReturnStatement>
+      <code><![CDATA[$result]]></code>
+    </MixedReturnStatement>
+    <PossiblyNullFunctionCall>
+      <code><![CDATA[\Closure::fromCallable([parent::class, 'compare'])->bindTo($self)($initial)]]></code>
+    </PossiblyNullFunctionCall>
     <PossiblyUndefinedStringArrayOffset>
       <code><![CDATA[$matches['type']]]></code>
       <code><![CDATA[$schema['Comment']]]></code>

src/Driver/MySQL/Schema/MySQLColumn.php

@@ -112,6 +112,7 @@ class MySQLColumn extends AbstractColumn
 
         //Additional types
         'json'        => 'json',
+        'snowflake'   => ['type' => 'bigint', 'size' => 20],
         'ulid'        => ['type' => 'varchar', 'size' => 26],
         'uuid'        => ['type' => 'varchar', 'size' => 36],
     ];

src/Driver/Postgres/Schema/PostgresColumn.php

@@ -181,6 +181,7 @@ class PostgresColumn extends AbstractColumn
         //Additional types
         'json'         => 'json',
         'jsonb'        => 'jsonb',
+        'snowflake'    => 'bigint',
         'ulid'         => ['type' => 'character varying', 'size' => 26],
         'uuid'         => 'uuid',
         'point'        => 'point',

src/Driver/SQLServer/Schema/SQLServerColumn.php

@@ -98,6 +98,7 @@ class SQLServerColumn extends AbstractColumn
 
         //Additional types
         'json'        => ['type' => 'varchar', 'size' => 0],
+        'snowflake'   => 'bigint',
         'ulid'        => ['type' => 'varchar', 'size' => 26],
         'uuid'        => ['type' => 'varchar', 'size' => 36],
     ];

src/Driver/SQLite/Schema/SQLiteColumn.php

@@ -87,6 +87,7 @@ class SQLiteColumn extends AbstractColumn
 
         //Additional types
         'json'        => 'text',
+        'snowflake'   => 'bigint',
         'ulid'        => ['type' => 'varchar', 'size' => 26],
         'uuid'        => ['type' => 'varchar', 'size' => 36],
     ];

src/Schema/AbstractColumn.php

@@ -50,6 +50,7 @@
  * @method $this|AbstractColumn tinyBinary()
  * @method $this|AbstractColumn longBinary()
  * @method $this|AbstractColumn json()
+ * @method $this|AbstractColumn snowflake()
  * @method $this|AbstractColumn ulid()
  * @method $this|AbstractColumn uuid()
  */

src/Schema/AbstractTable.php

@@ -51,6 +51,7 @@
  * @method AbstractColumn binary($column)
  * @method AbstractColumn tinyBinary($column)
  * @method AbstractColumn longBinary($column)
+ * @method AbstractColumn snowflake($column)
  * @method AbstractColumn ulid($column)
  * @method AbstractColumn uuid($column)
  */

tests/Database/Functional/Driver/Common/Schema/ConsistencyTest.php

@@ -360,6 +360,92 @@ public function testTime(): void
         $this->assertTrue($schema->column('target')->compare($column));
     }
 
+    public function testSnowflake(): void
+    {
+        $schema = $this->schema('table');
+        $this->assertFalse($schema->exists());
+
+        $column = $schema->snowflake('target');
+
+        $schema->save();
+
+        $schema = $this->schema('table');
+        $this->assertTrue($schema->exists());
+        $this->assertTrue($schema->column('target')->compare($column));
+        $this->assertSame('int', $schema->column('target')->getType());
+
+        $this->database->table('table')->insertOne(
+            [
+                'target' => 7340580095540599922,
+            ],
+        );
+
+        $this->assertEquals(
+            [
+                'target' => 7340580095540599922,
+            ],
+            $this->database->table('table')->select()->fetchAll()[0],
+        );
+    }
+
+    public function testSnowflakeCallingColumnMethod(): void
+    {
+        $schema = $this->schema('table');
+        $this->assertFalse($schema->exists());
+
+        $column = $schema->column('target')->snowflake();
+
+        $schema->save();
+
+        $schema = $this->schema('table');
+        $this->assertTrue($schema->exists());
+        $this->assertTrue($schema->column('target')->compare($column));
+        $this->assertSame('int', $schema->column('target')->getType());
+
+        $this->database->table('table')->insertOne(
+            [
+                'target' => 7340580095540599922,
+            ],
+        );
+
+        $this->assertEquals(
+            [
+                'target' => 7340580095540599922,
+            ],
+            $this->database->table('table')->select()->fetchAll()[0],
+        );
+    }
+
+    public function testSnowflakePrimary(): void
+    {
+        $schema = $this->schema('table');
+        $this->assertFalse($schema->exists());
+
+        $column = $schema->snowflake('target')->nullable(false);
+        $schema->setPrimaryKeys(['target']);
+        $schema->save();
+
+        $schema = $this->schema('table');
+        $this->assertTrue($schema->exists());
+
+        $this->assertTrue($schema->column('target')->compare($column));
+        $this->assertSame('int', $schema->column('target')->getType());
+        $this->assertSame(['target'], $schema->getPrimaryKeys());
+
+        $this->database->table('table')->insertOne(
+            [
+                'target' => 7340580095540599922,
+            ],
+        );
+
+        $this->assertEquals(
+            [
+                'target' => 7340580095540599922,
+            ],
+            $this->database->table('table')->select()->fetchAll()[0],
+        );
+    }
+
     public function testUlid(): void
     {
         $schema = $this->schema('table');