Skip to content

simplify using DATE_MAX as None/null by using a models.DateTimeField subclass #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions django_tasks/backends/database/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,3 @@ class TasksAppConfig(AppConfig):
name = "django_tasks.backends.database"
label = "django_tasks_database"
verbose_name = "Tasks Database Backend"

def ready(self) -> None:
from . import signal_handlers # noqa
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Generated by Django 5.1.4 on 2025-05-07 19:10

from django.db import migrations

import django_tasks.backends.database.models


class Migration(migrations.Migration):
dependencies = [
("django_tasks_database", "0016_alter_dbtaskresult_options_and_more"),
]

operations = [
migrations.AlterField(
model_name="dbtaskresult",
name="run_after",
field=django_tasks.backends.database.models.NullIsMaxDateTimeField(
verbose_name="run after"
),
),
]
22 changes: 20 additions & 2 deletions django_tasks/backends/database/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,24 @@ def __class_getitem__(cls, _):
DATE_MAX = datetime.datetime(9999, 1, 1, tzinfo=datetime.timezone.utc)


class NullIsMaxDateTimeField(models.DateTimeField):
"""
MySQL can only use indexes on simple queries, so instead of using null,
and nulls_last, or models.Case, set null/None as MAX_DATE, and vice-versa
"""

def get_prep_value(self, value): # type: ignore
value = super().get_prep_value(value)
if value is None:
value = DATE_MAX
return value

def from_db_value(self, value, expression, connection): # type: ignore
if value == DATE_MAX:
return None
return value


class DBTaskResultQuerySet(models.QuerySet):
def ready(self) -> "DBTaskResultQuerySet":
"""
Expand Down Expand Up @@ -104,7 +122,7 @@ class DBTaskResult(GenericBase[P, T], models.Model):
)
backend_name = models.CharField(_("backend name"), max_length=32)

run_after = models.DateTimeField(_("run after"))
run_after = NullIsMaxDateTimeField(_("run after"))

return_value = models.JSONField(_("return value"), default=None, null=True)

Expand Down Expand Up @@ -155,7 +173,7 @@ def task(self) -> Task[P, T]:
return task.using(
priority=self.priority,
queue_name=self.queue_name,
run_after=None if self.run_after == DATE_MAX else self.run_after,
run_after=self.run_after,
backend=self.backend_name,
)

Expand Down
12 changes: 0 additions & 12 deletions django_tasks/backends/database/signal_handlers.py

This file was deleted.

Loading