Simplified foreign key definition for single column fields

[Steveb-p]

Question	Answer
JIRA issue	N/A
Type	improvement
Target Ibexa version	v4.5
BC breaks	no

This PR allows definition of foreign relationship along with the field itself.

This makes it easier to spot a missing foreign key in schema.

Of course, this does not prevent the existing use of multi-column foreign keys via foreignKeys table property, in the same fashion as you can still create indexes and unique constraints.

Before

tables:
    ibexa_attribute_definition:
        indexes:
            ibexa_attribute_definition_attribute_group_idx:
                fields:
                    - attribute_group_id
        id:
            id:
                type: integer
                nullable: false
                options:
                    autoincrement: true
        fields:
            identifier:
                type: string
                nullable: false
                length: 64
            type:
                type: string
                nullable: false
                length: 32
            attribute_group_id:
                type: integer
                nullable: false
            position:
                type: integer
                nullable: false
                options:
                    default: 0
            options:
                type: json
                nullable: true
        uniqueConstraints:
            attribute_definition_identifier_idx:
                fields:
                    - identifier
        foreignKeys:
            ibexa_attribute_definition_attribute_group_fk:
                fields:
                    - attribute_group_id
                foreignTable: ibexa_attribute_group
                foreignFields:
                    - id
                options:
                    onDelete: CASCADE
                    onUpdate: CASCADE

After

tables:
    ibexa_attribute_definition:
        id:
            id:
                type: integer
                nullable: false
                options:
                    autoincrement: true
        fields:
            identifier:
                type: string
                nullable: false
                length: 64
                index:
                    name: attribute_definition_identifier_idx
                    unique: true
            type:
                type: string
                nullable: false
                length: 32
            attribute_group_id:
                type: integer
                nullable: false
                index: ibexa_attribute_definition_attribute_group_idx
                foreignKey:
                    name: ibexa_attribute_definition_attribute_group_fk
                    table: ibexa_attribute_group
                    field: id
                    options:
                        onDelete: CASCADE
                        onUpdate: CASCADE
            position:
                type: integer
                nullable: false
                options:
                    default: 0
            options:
                type: json
                nullable: true

Difference

 tables:
     ibexa_attribute_definition:
-        indexes:
-            ibexa_attribute_definition_attribute_group_idx:
-                fields:
-                    - attribute_group_id
         id:
             id:
                 type: integer
                 nullable: false
                 options:
                     autoincrement: true
         fields:
             identifier:
                 type: string
                 nullable: false
                 length: 64
+                index:
+                    name: attribute_definition_identifier_idx
+                    unique: true
             type:
                 type: string
                 nullable: false
                 length: 32
             attribute_group_id:
                 type: integer
                 nullable: false
+                index: ibexa_attribute_definition_attribute_group_idx
+                foreignKey:
+                    name: ibexa_attribute_definition_attribute_group_fk
+                    table: ibexa_attribute_group
+                    field: id
+                    options:
+                        onDelete: CASCADE
+                        onUpdate: CASCADE
             position:
                 type: integer
                 nullable: false
                 options:
                     default: 0
             options:
                 type: json
                 nullable: true
-        uniqueConstraints:
-            attribute_definition_identifier_idx:
-                fields:
-                    - identifier
-        foreignKeys:
-            ibexa_attribute_definition_attribute_group_fk:
-                fields:
-                    - attribute_group_id
-                foreignTable: ibexa_attribute_group
-                foreignFields:
-                    - id
-                options:
-                    onDelete: CASCADE
-                    onUpdate: CASCADE

Checklist:

• Provided PR description.
• Tested the solution manually.
• Provided automated test coverage.
• Checked that target branch is set correctly (main for features, the oldest supported for bugs).
• Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
• Asked for a review (ping @ibexa/engineering).

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication