fix: pass join column options to FK

Author: vencakrecl

.DS_Store

@@ -686,6 +686,7 @@ Optional parameters:
    make foreign keys work.
 -  **options**:
    See "options" attribute on :ref:`#[Column] <attrref_column>`.
+   It's possible to add other options, for example (PostgreSQL) `['deferrable' => true, 'deferred' => true]`.
 
 Example:
 

docs/en/reference/attributes-reference.rst

@@ -38,12 +38,14 @@
 use function array_flip;
 use function array_intersect_key;
 use function array_map;
+use function array_replace;
 use function assert;
 use function class_exists;
 use function count;
 use function current;
 use function implode;
 use function in_array;
+use function is_array;
 use function is_numeric;
 use function method_exists;
 use function strtolower;
@@ -715,6 +717,10 @@ private function gatherRelationJoinColumns(
                 $uniqueConstraints[] = ['columns' => [$quotedColumnName]];
             }
 
+            if (is_array($joinColumn->options)) {
+                $fkOptions = array_replace($fkOptions, $joinColumn->options);
+            }
+
             if (isset($joinColumn->onDelete)) {
                 $fkOptions['onDelete'] = $joinColumn->onDelete;
             }

src/Tools/SchemaTool.php

@@ -11,11 +11,13 @@
 use Doctrine\ORM\Mapping\Id;
 use Doctrine\ORM\Mapping\JoinColumn;
 use Doctrine\ORM\Mapping\ManyToOne;
+use Doctrine\ORM\Mapping\OneToOne;
 use Doctrine\ORM\Mapping\Table;
 use Doctrine\Tests\OrmFunctionalTestCase;
 use PHPUnit\Framework\Attributes\Group;
 
 use function array_filter;
+use function array_slice;
 use function implode;
 use function str_starts_with;
 
@@ -42,6 +44,60 @@ public function testUpdateSchemaWithPostgreSQLSchema(): void
 
         self::assertCount(0, $sql, implode("\n", $sql));
     }
+
+    public function testUpdateSchemaWithJoinColumnWithOptions(): void
+    {
+        $sql = $this->getUpdateSchemaSqlForModels(
+            TestEntityWithJoinColumnWithOptions::class,
+            TestEntityWithJoinColumnWithOptionsRelation::class,
+        );
+
+        $this->assertSame([
+            'CREATE TABLE test (id INT NOT NULL, testRelation1_id INT DEFAULT NULL, testRelation2_id INT DEFAULT NULL, PRIMARY KEY(id))',
+            'CREATE UNIQUE INDEX UNIQ_D87F7E0C331521C6 ON test (testRelation1_id)',
+            'CREATE UNIQUE INDEX UNIQ_D87F7E0C21A08E28 ON test (testRelation2_id)',
+            'CREATE TABLE test_relation (id INT NOT NULL, PRIMARY KEY(id))',
+            'ALTER TABLE test ADD CONSTRAINT FK_D87F7E0C331521C6 FOREIGN KEY (testRelation1_id) REFERENCES test_relation (id) DEFERRABLE INITIALLY DEFERRED',
+            'ALTER TABLE test ADD CONSTRAINT FK_D87F7E0C21A08E28 FOREIGN KEY (testRelation2_id) REFERENCES test_relation (id) NOT DEFERRABLE INITIALLY IMMEDIATE',
+        ], array_slice($sql, 0, 5));
+
+        foreach ($sql as $query) {
+            $this->_em->getConnection()->executeQuery($query);
+        }
+
+        $sql = $this->getUpdateSchemaSqlForModels(
+            TestEntityWithJoinColumnWithOptions::class,
+            TestEntityWithJoinColumnWithOptionsRelation::class,
+        );
+
+        $this->assertSame([], $sql);
+    }
+}
+
+#[Table('test')]
+#[Entity]
+class TestEntityWithJoinColumnWithOptions
+{
+    #[Id]
+    #[Column]
+    private int $id;
+
+    #[OneToOne(targetEntity: TestEntityWithJoinColumnWithOptionsRelation::class)]
+    #[JoinColumn(options: ['deferrable' => true, 'deferred' => true])]
+    private TestEntityWithJoinColumnWithOptionsRelation $testRelation1;
+
+    #[OneToOne(targetEntity: TestEntityWithJoinColumnWithOptionsRelation::class)]
+    #[JoinColumn]
+    private TestEntityWithJoinColumnWithOptionsRelation $testRelation2;
+}
+
+#[Table('test_relation')]
+#[Entity]
+class TestEntityWithJoinColumnWithOptionsRelation
+{
+    #[Id]
+    #[Column]
+    private int $id;
 }
 
 #[Table(name: 'stonewood.screen')]

tests/Tests/ORM/Functional/SchemaTool/PostgreSqlSchemaToolTest.php

@@ -5,6 +5,7 @@
 namespace Doctrine\Tests\ORM\Tools;
 
 use Doctrine\Common\Collections\Collection;
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\DBAL\Schema\ForeignKeyConstraintEditor;
 use Doctrine\DBAL\Schema\Index as DbalIndex;
 use Doctrine\DBAL\Schema\Index\IndexedColumn;
@@ -452,6 +453,53 @@ private static function columnIsIndexed(DbalTable $table, string $column): bool
 
         return false;
     }
+
+    public function testJoinColumnWithOptions(): void
+    {
+        $em         = $this->getTestEntityManager();
+        $schemaTool = new SchemaTool($em);
+
+        $classes = [
+            $em->getClassMetadata(TestEntityWithJoinColumnWithOptions::class),
+            $em->getClassMetadata(TestEntityWithJoinColumnWithOptionsRelation::class),
+        ];
+
+        $schema = $schemaTool->getSchemaFromMetadata($classes);
+
+        self::assertSame(['deferrable' => true, 'deferred' => true], $schema->getTable('test')->getForeignKey('FK_D87F7E0C331521C6')->getOptions());
+        self::assertSame([], $schema->getTable('test')->getForeignKey('FK_D87F7E0C21A08E28')->getOptions());
+
+        $sql = $schema->toSql(new PostgreSQLPlatform());
+
+        $this->assertSame('ALTER TABLE test ADD CONSTRAINT FK_D87F7E0C331521C6 FOREIGN KEY (testRelation1_id) REFERENCES test_relation (id) DEFERRABLE INITIALLY DEFERRED', $sql[count($sql) - 2]);
+        $this->assertSame('ALTER TABLE test ADD CONSTRAINT FK_D87F7E0C21A08E28 FOREIGN KEY (testRelation2_id) REFERENCES test_relation (id) NOT DEFERRABLE INITIALLY IMMEDIATE', $sql[count($sql) - 1]);
+    }
+}
+
+#[Table('test')]
+#[Entity]
+class TestEntityWithJoinColumnWithOptions
+{
+    #[Id]
+    #[Column]
+    private int $id;
+
+    #[OneToOne(targetEntity: TestEntityWithJoinColumnWithOptionsRelation::class)]
+    #[JoinColumn(options: ['deferrable' => true, 'deferred' => true])]
+    private TestEntityWithJoinColumnWithOptionsRelation $testRelation1;
+
+    #[OneToOne(targetEntity: TestEntityWithJoinColumnWithOptionsRelation::class)]
+    #[JoinColumn]
+    private TestEntityWithJoinColumnWithOptionsRelation $testRelation2;
+}
+
+#[Table('test_relation')]
+#[Entity]
+class TestEntityWithJoinColumnWithOptionsRelation
+{
+    #[Id]
+    #[Column]
+    private int $id;
 }
 
 #[Table(options: ['foo' => 'bar', 'baz' => ['key' => 'val']])]