DjangoORM：解析自定义数据库函数中的 F 表达式

Question

我正在尝试在 Django 中编写自定义 PostgreSQL 函数，它将日期时间强制转换为查询集内的指定时区。我对 db 函数的第一遍看起来像这样：

from django.db.models.expressions import Func

class DateTimeInTimezone(Func):
    template="%(expressions)s AT TIME ZONE %(tz_info)s"

此函数适用于我将时区字符串直接传递给函数的简单情况，如下所示：

MyModel.objects.filter(timefield__gte=DateTimeInTimezone(Now(), tz_info='EST'))

然而，它在更复杂的情况下不起作用，在这种情况下，时区是在模型的某个字段上定义的。考虑以下人为的示例：

class User(models.Model):
    time_zone = models.CharField()

class Meeting(models.Model):
    users = models.ManyToManyField(User, related_name='meetings')
    start_time = models.DateTimeField()  # in UTC
    end_time = models.DateTimeField()  # in UTC

要回答问题 "What users will be in a meeting at 12pm local time today?"，我需要此查询集的一些变体：

noon_utc = ...
User.objects.filter(
    meetings__start_time__lte=DateTimeInTimezone(noon_utc, tz_info=F('time_zone')),
    meetings__end_time__gt=DateTimeInTimezone(noon_utc, tz_info=F('time_zone'))
)

然而，正如目前所写，DateTimeInTimezone 只会将字符串 F('time_zone') 注入 sql 而不是解析该字段。

是否可以为此功能添加对 F Expressions 的支持？我应该考虑其他方法吗？

Answer 1

找到可接受的解决方案。我覆盖了 as_sql 函数的方法，这样，允许 django 内部解析 F 表达式，然后将它分离回一个我可以在模板的不同部分使用的 kwarg。

class DateTimeInTimezone(Func):
'''
Coerce a datetime into a specified timezone
'''
template="%(expressions)s AT TIME ZONE %(tz_info)s"
arity = 2

def as_sql(self, compiler, connection, function=None, template=None, arg_joiner=None, **extra_context):
    connection.ops.check_expression_support(self)
    sql_parts = []
    params = []
    for arg in self.source_expressions:
        arg_sql, arg_params = compiler.compile(arg)
        sql_parts.append(arg_sql)
        params.extend(arg_params)
    data = self.extra.copy()
    data.update(**extra_context)
    # Use the first supplied value in this order: the parameter to this
    # method, a value supplied in __init__()'s **extra (the value in
    # `data`), or the value defined on the class.
    if function is not None:
        data['function'] = function
    else:
        data.setdefault('function', self.function)
    template = template or data.get('template', self.template)
    arg_joiner = arg_joiner or data.get('arg_joiner', self.arg_joiner)
    data['expressions'] = data['field'] = arg_joiner.join(sql_parts)
    parts = data['expressions'].split(', ')
    data['expressions'] = parts[0]
    data['tz_info'] = parts[1]
    return template % data, params

我在赋值 data['expressions'] 和最后的 return template % data, params 之间添加了三行。这不是一个很好的长期解决方案，因为此方法的 django 内部结构可能会在下一个版本中发生变化，但它暂时适合我的需要。

Answer 2

一个简单的解决方案是可能的 with 参数 arg_joiner:

class DateTimeInTimezone(Func):
    function = ''
    arg_joiner = ' AT TIME ZONE '

    def __init__(self, timestamp, tz_info):
        super(DateTimeInTimezone, self).__init__(timestamp, tz_info)

方法__init__仅用于参数名称清晰的可读性目的。然后 arity 如果参数由 __init__.

声明则不重要

如果可读性不重要，oneliner 函数对于快速开发很有用：

...filter(
    meetings__start_time__lte=Func(noon_utc, tz_info=F('time_zone'), arg_joiner=' AT TIME ZONE ', function=''),
)

已验证：

>>> qs = User.objects.filter(...)
>>> print(str(qs.query))
SELECT ... WHERE ("app_meeting"."start_time" <= ((2017-10-03 08:18:12.663640 AT TIME ZONE "app_user"."time_zone")) AND ...)

DjangoORM：解析自定义数据库函数中的 F 表达式

DjangoORM: Resolve F Expression in Custom DB Function

django

django-queryset

django-orm

django-1.10

django-postgresql