on_delete should be required in all type relations #1801.

CHANGELOG.rst

@@ -9,6 +9,13 @@ Changelog
 0.24
 ====
 
+0.25.0 (Unreleased)
+------
+
+Changed
+^^^^^^^
+- on_delete is mandatory in all relations. (#1801))
+
 0.24.2 (Unreleased)
 ------
 

pyproject.toml

@@ -48,6 +48,7 @@ aiomysql = { version = "*", optional = true }
 asyncmy = { version = "^0.2.8", optional = true, allow-prereleases = true }
 psycopg = { extras = ["pool", "binary"], version = "^3.0.12", optional = true }
 asyncodbc = { version = "^0.1.1", optional = true }
+importlib-metadata = "^8.6.1"
 
 [tool.poetry.group.dev.dependencies]
 # Linter tools

tests/model_setup/model_bad_rel1.py

@@ -3,6 +3,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -12,5 +13,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "app.Tournament", related_name="events"
+        "app.Tournament", related_name="events", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel2.py

@@ -8,6 +8,7 @@
 from typing import Any
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -17,5 +18,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Any] = fields.ForeignKeyField(
-        "models.Tour", related_name="events"
+        "models.Tour", related_name="events", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel3.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "Tournament", related_name="events"
+        "Tournament", related_name="events", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel4.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.app.Tournament", related_name="events"
+        "models.app.Tournament", related_name="events", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel5.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -12,4 +13,6 @@ class Tournament(Model):
 
 
 class Event(Model):
-    tournament: fields.OneToOneRelation[Tournament] = fields.OneToOneField("Tournament")
+    tournament: fields.OneToOneRelation[Tournament] = fields.OneToOneField(
+        "Tournament", on_delete=CASCADE
+    )

tests/model_setup/model_bad_rel6.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", to_field="uuid"
+        "models.Tournament", related_name="events", to_field="uuid", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel7.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", to_field="uuids"
+        "models.Tournament", related_name="events", to_field="uuids", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel8.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.OneToOneRelation[Tournament] = fields.OneToOneField(
-        "models.Tournament", related_name="events", to_field="uuid"
+        "models.Tournament", related_name="events", to_field="uuid", on_delete=CASCADE
     )

tests/model_setup/model_bad_rel9.py

@@ -4,6 +4,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.OneToOneRelation[Tournament] = fields.OneToOneField(
-        "models.Tournament", related_name="events", to_field="uuids"
+        "models.Tournament", related_name="events", to_field="uuids", on_delete=CASCADE
     )

tests/model_setup/models_dup1.py

@@ -3,6 +3,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -12,11 +13,11 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events"
+        "models.Tournament", related_name="events", on_delete=CASCADE
     )
 
 
 class Party(Model):
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events"
+        "models.Tournament", related_name="events", on_delete=CASCADE
     )

tests/model_setup/models_dup2.py

@@ -3,18 +3,19 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
 class Event(Model):
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
-        "models.Team", related_name="events", through="event_team"
+        "models.Team", related_name="events", through="event_team", on_delete=CASCADE
     )
 
 
 class Party(Model):
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
-        "models.Team", related_name="events", through="event_team"
+        "models.Team", related_name="events", through="event_team", on_delete=CASCADE
     )
 
 

tests/model_setup/models_dup3.py

@@ -3,6 +3,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -13,5 +14,5 @@ class Tournament(Model):
 
 class Event(Model):
     tournament: fields.OneToOneRelation[Tournament] = fields.OneToOneField(
-        "models.Tournament", related_name="event"
+        "models.Tournament", related_name="event", on_delete=CASCADE
     )

tests/schema/models_cyclic.py

@@ -3,22 +3,23 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
 class One(Model):
     tournament: fields.ForeignKeyRelation["Two"] = fields.ForeignKeyField(
-        "models.Two", related_name="events"
+        "models.Two", related_name="events", on_delete=CASCADE
     )
 
 
 class Two(Model):
     tournament: fields.ForeignKeyRelation["Three"] = fields.ForeignKeyField(
-        "models.Three", related_name="events"
+        "models.Three", related_name="events", on_delete=CASCADE
     )
 
 
 class Three(Model):
     tournament: fields.ForeignKeyRelation[One] = fields.ForeignKeyField(
-        "models.One", related_name="events"
+        "models.One", related_name="events", on_delete=CASCADE
     )

tests/schema/models_fk_1.py

@@ -7,8 +7,9 @@
 from typing import Any
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
 class One(Model):
-    tournament: fields.ForeignKeyRelation[Any] = fields.ForeignKeyField("moo")
+    tournament: fields.ForeignKeyRelation[Any] = fields.ForeignKeyField("moo", on_delete=CASCADE)

tests/schema/models_m2m_1.py

@@ -4,8 +4,9 @@
 
 from tests.schema.models_cyclic import Two
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
 class One(Model):
-    tournament: fields.ManyToManyRelation[Two] = fields.ManyToManyField("Two")
+    tournament: fields.ManyToManyRelation[Two] = fields.ManyToManyField("Two", on_delete=CASCADE)

tests/schema/models_m2m_2.py

@@ -5,6 +5,7 @@
 from __future__ import annotations
 
 from tortoise import Model, fields
+from tortoise.fields import CASCADE
 
 
 class One(Model):
@@ -16,5 +17,5 @@ class Two(Model):
 
 
 class Three(Model):
-    ones: fields.ManyToManyRelation[One] = fields.ManyToManyField("models.One")
-    twos: fields.ManyToManyRelation[Two] = fields.ManyToManyField("models.Two")
+    ones: fields.ManyToManyRelation[One] = fields.ManyToManyField("models.One", on_delete=CASCADE)
+    twos: fields.ManyToManyRelation[Two] = fields.ManyToManyField("models.Two", on_delete=CASCADE)

tests/schema/models_no_auto_create_m2m.py

@@ -3,7 +3,7 @@
 """
 
 from tortoise import fields
-from tortoise.fields import SET_NULL
+from tortoise.fields import CASCADE, SET_NULL
 from tortoise.models import Model
 
 
@@ -20,7 +20,10 @@ class Event(Model):
     id = fields.BigIntField(primary_key=True, description="Event ID")
     name = fields.TextField()
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", description="FK to tournament"
+        "models.Tournament",
+        related_name="events",
+        description="FK to tournament",
+        on_delete=CASCADE,
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team",
@@ -41,10 +44,10 @@ class Meta:
 
 class TeamEvent(Model):
     team: fields.ForeignKeyRelation["Team"] = fields.ForeignKeyField(
-        "models.Team", related_name="teams"
+        "models.Team", related_name="teams", on_delete=CASCADE
     )
     event: fields.ForeignKeyRelation[Event] = fields.ForeignKeyField(
-        "models.Event", related_name="events"
+        "models.Event", related_name="events", on_delete=CASCADE
     )
     score = fields.IntField()
 
@@ -58,10 +61,12 @@ class Team(Model):
     name = fields.CharField(max_length=50, primary_key=True, description="The TEAM name (and PK)")
     key = fields.IntField()
     manager: fields.ForeignKeyNullableRelation["Team"] = fields.ForeignKeyField(
-        "models.Team", related_name="team_members", null=True
+        "models.Team", related_name="team_members", null=True, on_delete=CASCADE
     )
     talks_to: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
-        "models.Team", related_name="gets_talked_to"
+        "models.Team",
+        related_name="gets_talked_to",
+        on_delete=CASCADE,
     )
 
     class Meta:

tests/schema/models_no_db_constraint.py

@@ -3,6 +3,7 @@
 """
 
 from tortoise import fields
+from tortoise.fields import CASCADE
 from tortoise.models import Model
 
 
@@ -23,13 +24,15 @@ class Event(Model):
         db_constraint=False,
         related_name="events",
         description="FK to tournament",
+        on_delete=CASCADE,
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team",
         db_constraint=False,
         related_name="events",
         through="teamevents",
         description="How participants relate",
+        on_delete=CASCADE,
     )
     modified = fields.DatetimeField(auto_now=True)
     prize = fields.DecimalField(max_digits=10, decimal_places=2, null=True)
@@ -45,10 +48,14 @@ class Team(Model):
     name = fields.CharField(max_length=50, primary_key=True, description="The TEAM name (and PK)")
     key = fields.IntField()
     manager: fields.ForeignKeyNullableRelation["Team"] = fields.ForeignKeyField(
-        "models.Team", db_constraint=False, related_name="team_members", null=True
+        "models.Team",
+        db_constraint=False,
+        related_name="team_members",
+        null=True,
+        on_delete=CASCADE,
     )
     talks_to: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
-        "models.Team", db_constraint=False, related_name="gets_talked_to"
+        "models.Team", db_constraint=False, related_name="gets_talked_to", on_delete=CASCADE
     )
 
     class Meta: