数据库函数 — Django 文档
数据库函数
下面记录的类为用户提供了一种使用底层数据库提供的函数作为 Django 中的注释、聚合或过滤器的方法。 函数也是表达式,因此它们可以与聚合函数等其他表达式结合使用。
我们将在每个函数的示例中使用以下模型:
我们通常不建议为 CharField
允许 null=True
,因为这允许该字段有两个“空值”,但这对于下面的 Coalesce
示例很重要。
比较和转换功能
Cast
- class Cast(expression, output_field)
强制 expression
的结果类型为 output_field
中的结果类型。
用法示例:
Coalesce
- class Coalesce(*expressions, **extra)
接受至少包含两个字段名称或表达式的列表,并返回第一个非空值(请注意,空字符串不被视为空值)。 每个参数必须是相似的类型,所以混合文本和数字会导致数据库错误。
用法示例:
警告
除非显式转换为正确的数据库类型,否则在 MySQL 上传递给 Coalesce
的 Python 值可能会转换为不正确的类型:
Greatest
- class Greatest(*expressions, **extra)
接受至少包含两个字段名称或表达式的列表并返回最大值。 每个参数必须是相似的类型,所以混合文本和数字会导致数据库错误。
用法示例:
annotated_comment.last_updated
将是 blog.modified
和 comment.modified
中最新的。
警告
当一个或多个表达式可能是 null
时,Greatest
的行为因数据库而异:
- PostgreSQL:
Greatest
将返回最大的非空表达式,如果所有表达式都是null
,则返回null
。 - SQLite、Oracle 和 MySQL:如果任何表达式为
null
,则Greatest
将返回null
。
如果您知道要作为默认值提供的合理最小值,则可以使用 Coalesce
模拟 PostgreSQL 行为。
Least
- class Least(*expressions, **extra)
接受至少包含两个字段名称或表达式的列表并返回最小值。 每个参数必须是相似的类型,所以混合文本和数字会导致数据库错误。
警告
当一个或多个表达式可能是 null
时,Least
的行为因数据库而异:
- PostgreSQL:
Least
将返回最小的非空表达式,如果所有表达式都是null
,则返回null
。 - SQLite、Oracle 和 MySQL:如果任何表达式为
null
,则Least
将返回null
。
如果您知道要提供的合理最大值作为默认值,则可以使用 Coalesce
模拟 PostgreSQL 行为。
日期函数
我们将在每个函数的示例中使用以下模型:
Extract
- class Extract(expression, lookup_name=None, tzinfo=None, **extra)
将日期的一部分提取为数字。
取一个表示 DateField
、DateTimeField
、TimeField
或 DurationField
和一个 lookup_name
的 expression
,并返回lookup_name
作为 IntegerField
引用的日期的一部分。 Django 通常使用数据库的提取功能,因此您可以使用数据库支持的任何 lookup_name
。 通常由 pytz
提供的 tzinfo
子类可以传递以提取特定时区中的值。
给定日期时间 2015-06-15 23:30:01.000321+00:00
,内置的 lookup_name
s 返回:
- “年”:2015
- “iso_year”:2015
- “季度”:2
- “月”:6
- “天”:15
- “周”:25
- “week_day”:2
- “小时”:23
- “分钟”:30
- “第二个”:1
如果像 Australia/Melbourne
这样的不同时区在 Django 中处于活动状态,则在提取值之前将日期时间转换为时区。 上面示例日期中墨尔本的时区偏移为 +10:00。 此时区处于活动状态时返回的值将与上述相同,除了:
- “天”:16
- “week_day”:3
- “小时”:9
week_day
值
week_day
lookup_type
的计算方式与大多数数据库和 Python 的标准函数不同。 此函数将返回 1
星期日,2
星期一,通过 7
星期六。
Python 中的等效计算是:
week
值
week
lookup_type
根据ISO-8601计算,即一周从星期一开始。 一年的第一周是包含该年第一个星期四的那一周,即 第一周是一年中的大部分(四天或更多)天。 返回的值在 1 到 52 或 53 的范围内。
上面的每个 lookup_name
都有一个相应的 Extract
子类(如下所列),通常应该使用它来代替更冗长的等效项,例如 使用 ExtractYear(...)
而不是 Extract(..., lookup_name='year')
。
用法示例:
DateField 摘录
- class ExtractYear(expression, tzinfo=None, **extra)
- ;; lookup_name = 'year'
- class ExtractIsoYear(expression, tzinfo=None, **extra)
2.2 版中的新功能。
返回 ISO-8601 周编号年份。
- lookup_name = 'iso_year'
- class ExtractMonth(expression, tzinfo=None, **extra)
- ;; lookup_name = 'month'
- class ExtractDay(expression, tzinfo=None, **extra)
- ;; lookup_name = 'day'
- class ExtractWeekDay(expression, tzinfo=None, **extra)
- ;; lookup_name = 'week_day'
- class ExtractWeek(expression, tzinfo=None, **extra)
- ;; lookup_name = 'week'
- class ExtractQuarter(expression, tzinfo=None, **extra)
- ;; lookup_name = 'quarter'
这些在逻辑上等同于 Extract('date_field', lookup_name)
。 每个类也是在 DateField
和 DateTimeField
上注册为 __(lookup_name)
的 Transform
,例如 __year
。
由于 DateField
没有时间分量,因此只有处理日期部分的 Extract
子类可以与 DateField
一起使用:
DateTimeField 摘录
除了以下内容之外,上面列出的 DateField
的所有提取物也可以用于 DateTimeField
s 。
- class ExtractHour(expression, tzinfo=None, **extra)
- ;; lookup_name = 'hour'
- class ExtractMinute(expression, tzinfo=None, **extra)
- ;; lookup_name = 'minute'
- class ExtractSecond(expression, tzinfo=None, **extra)
- ;; lookup_name = 'second'
这些在逻辑上等同于 Extract('datetime_field', lookup_name)
。 每个类也是一个在 DateTimeField
上注册为 __(lookup_name)
的 Transform
,例如 __minute
。
DateTimeField
示例:
当 :setting:`USE_TZ` 为 True
时,日期时间以 UTC 格式存储在数据库中。 如果不同的时区在 Django 中处于活动状态,则在提取值之前将日期时间转换为该时区。 下面的示例转换为墨尔本时区 (UTC +10:00),这会更改返回的天、工作日和小时值:
将时区显式传递给 Extract
函数的行为方式相同,并且优先于活动时区:
Now
- class Now
返回执行查询时数据库服务器的当前日期和时间,通常使用 SQL CURRENT_TIMESTAMP
。
用法示例:
PostgreSQL 注意事项
在 PostgreSQL 上,SQL CURRENT_TIMESTAMP
返回当前事务开始的时间。 因此为了跨数据库兼容性,Now()
使用 STATEMENT_TIMESTAMP
代替。 如果您需要交易时间戳,请使用 django.contrib.postgres.functions.TransactionNow。
Trunc
- class Trunc(expression, kind, output_field=None, tzinfo=None, is_dst=None, **extra)
将日期截断为重要组成部分。
当您只关心某事是否发生在特定的年、小时或日,而不是确切的秒时,那么 Trunc
(及其子类)可用于过滤或聚合您的数据。 例如,您可以使用 Trunc
来计算每天的销售数量。
Trunc
取单个 expression
,代表一个 DateField
、TimeField
或 DateTimeField
,一个 kind
代表一个日期或时间部分,以及 output_field
是 DateTimeField()
、TimeField()
或 DateField()
。 它根据 output_field
返回日期时间、日期或时间,最多 kind
的字段设置为其最小值。 如果省略output_field
,则默认为expression
的output_field
。 通常由 pytz
提供的 tzinfo
子类可以传递以截断特定时区中的值。
is_dst
参数指示 pytz
是否应在夏令时解释不存在和不明确的日期时间。 默认情况下(当 is_dst=None
时),pytz
会引发此类日期时间的异常。
3.0 新特性:增加了is_dst
参数。
给定日期时间 2015-06-15 14:30:50.000321+00:00
,内置的 kind
s 返回:
- “年”:2015-01-01 00:00:00+00:00
- “季”:2015-04-01 00:00:00+00:00
- “月”:2015-06-01 00:00:00+00:00
- “周”:2015-06-15 00:00:00+00:00
- “日”:2015-06-15 00:00:00+00:00
- “小时”:2015-06-15 14:00:00+00:00
- “分钟”:2015-06-15 14:30:00+00:00
- “第二个”:2015-06-15 14:30:50+00:00
如果像 Australia/Melbourne
这样的不同时区在 Django 中处于活动状态,则日期时间会在值被截断之前转换为新时区。 上面示例日期中墨尔本的时区偏移为 +10:00。 此时区处于活动状态时返回的值将是:
- “年”:2015-01-01 00:00:00+11:00
- “季”:2015-04-01 00:00:00+10:00
- “月”:2015-06-01 00:00:00+10:00
- “周”:2015-06-16 00:00:00+10:00
- “日”:2015-06-16 00:00:00+10:00
- “小时”:2015-06-16 00:00:00+10:00
- “分钟”:2015-06-16 00:30:00+10:00
- “第二个”:2015-06-16 00:30:50+10:00
年份的偏移量为 +11:00,因为结果转换为夏令时。
上面的每个 kind
都有一个相应的 Trunc
子类(如下所列),通常应该使用它来代替更冗长的等效项,例如 使用 TruncYear(...)
而不是 Trunc(..., kind='year')
。
子类都定义为转换,但它们没有注册到任何字段,因为明显的查找名称已经被 Extract
子类保留。
用法示例:
DateField 截断
- class TruncYear(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'year'
- class TruncMonth(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'month'
- class TruncWeek(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- 截断到每周星期一的午夜。
- kind = 'week'
- class TruncQuarter(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'quarter'
这些在逻辑上等同于 Trunc('date_field', kind)
。 它们将日期的所有部分截断到 kind
,这允许以较低的精度对日期进行分组或过滤。 expression
的 output_field
可以是 DateField
或 DateTimeField
。
由于 DateField
没有时间分量,因此只有处理日期部分的 Trunc
子类可以与 DateField
一起使用:
DateTimeField 截断
- class TruncDate(expression, **extra)
- lookup_name = 'date'
- output_field = DateField()
TruncDate
将 expression
转换为日期,而不是使用内置的 SQL 截断函数。 它也在 DateTimeField
上注册为 __date
的转换。
- class TruncTime(expression, **extra)
- lookup_name = 'time'
- output_field = TimeField()
TruncTime
将 expression
转换为时间,而不是使用内置的 SQL 截断函数。 它也在 DateTimeField
上注册为 __time
的转换。
- class TruncDay(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'day'
- class TruncHour(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'hour'
- class TruncMinute(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'minute'
- class TruncSecond(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'second'
这些在逻辑上等同于 Trunc('datetime_field', kind)
。 它们将日期的所有部分截断到 kind
并允许以较低的精度对日期时间进行分组或过滤。 expression
必须有 DateTimeField
的 output_field
。
用法示例:
TimeField 截断
- class TruncHour(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'hour'
- class TruncMinute(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'minute'
- class TruncSecond(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
- ;; kind = 'second'
这些在逻辑上等同于 Trunc('time_field', kind)
。 它们将时间的所有部分截断到 kind
,这允许以较低的精度对时间进行分组或过滤。 expression
的 output_field
可以是 TimeField
或 DateTimeField
。
由于 TimeField
没有日期组件,因此只有处理时间部分的 Trunc
子类可以与 TimeField
一起使用:
数学函数
2.2 版中的新功能。
我们将在数学函数示例中使用以下模型:
Abs
- class Abs(expression, **extra)
返回数字字段或表达式的绝对值。
用法示例:
它也可以注册为转换。 例如:
ACos
- class ACos(expression, **extra)
返回数字字段或表达式的反余弦值。 表达式值必须在 -1 到 1 的范围内。
用法示例:
它也可以注册为转换。 例如:
ASin
- class ASin(expression, **extra)
返回数值字段或表达式的反正弦。 表达式值必须在 -1 到 1 的范围内。
用法示例:
它也可以注册为转换。 例如:
ATan
- class ATan(expression, **extra)
返回数值字段或表达式的反正切。
用法示例:
它也可以注册为转换。 例如:
ATan2
- class ATan2(expression1, expression2, **extra)
返回 expression1 / expression2
的反正切值。
用法示例:
Ceil
- class Ceil(expression, **extra)
返回大于或等于数字字段或表达式的最小整数。
用法示例:
它也可以注册为转换。 例如:
Cos
- class Cos(expression, **extra)
返回数字字段或表达式的余弦。
用法示例:
它也可以注册为转换。 例如:
Cot
- class Cot(expression, **extra)
返回数值字段或表达式的余切。
用法示例:
它也可以注册为转换。 例如:
Degrees
- class Degrees(expression, **extra)
将数值字段或表达式从弧度转换为度数。
用法示例:
它也可以注册为转换。 例如:
Exp
- class Exp(expression, **extra)
返回 e
(自然对数底)的数值字段或表达式的幂。
用法示例:
它也可以注册为转换。 例如:
Floor
- class Floor(expression, **extra)
返回不大于数字字段或表达式的最大整数值。
用法示例:
它也可以注册为转换。 例如:
Ln
- class Ln(expression, **extra)
返回数字字段或表达式的自然对数。
用法示例:
它也可以注册为转换。 例如:
Log
- class Log(expression1, expression2, **extra)
接受两个数字字段或表达式,并返回第一个以第二个为底的对数。
用法示例:
Mod
- class Mod(expression1, expression2, **extra)
接受两个数字字段或表达式,并返回第一个的余数除以第二个(模运算)。
用法示例:
Pi
- class Pi(**extra)
返回数学常数 π
的值。
Power
- class Power(expression1, expression2, **extra)
接受两个数字字段或表达式,并返回第一个的值的第二个幂。
用法示例:
Radians
- class Radians(expression, **extra)
将数值字段或表达式从度数转换为弧度。
用法示例:
它也可以注册为转换。 例如:
Round
- class Round(expression, **extra)
将数字字段或表达式四舍五入为最接近的整数。 半值是向上还是向下四舍五入取决于数据库。
用法示例:
它也可以注册为转换。 例如:
Sign
- class Sign(expression, **extra)
3.0 版中的新功能。
返回数字字段或表达式的符号 (-1, 0, 1)。
用法示例:
它也可以注册为转换。 例如:
Sin
- class Sin(expression, **extra)
返回数字字段或表达式的正弦值。
用法示例:
它也可以注册为转换。 例如:
Sqrt
- class Sqrt(expression, **extra)
返回非负数值字段或表达式的平方根。
用法示例:
它也可以注册为转换。 例如:
Tan
- class Tan(expression, **extra)
返回数值字段或表达式的切线。
用法示例:
它也可以注册为转换。 例如:
文字功能
Chr
- class Chr(expression, **extra)
接受数字字段或表达式,并将表达式的文本表示形式作为单个字符返回。 它的工作原理与 Python 的 chr()
函数相同。
与 Length 一样,它可以注册为 IntegerField
上的变换。 默认查找名称是 chr
。
用法示例:
Concat
- class Concat(*expressions, **extra)
接受至少两个文本字段或表达式的列表并返回连接的文本。 每个参数必须是文本或字符类型。 如果你想连接一个 TextField()
和一个 CharField()
,那么一定要告诉 Django output_field
应该是一个 TextField()
。 在连接 Value
时,也需要指定 output_field
,如下例所示。
此函数永远不会有空结果。 在 null 参数导致整个表达式为 null 的后端,Django 将确保每个 null 部分首先转换为空字符串。
用法示例:
Left
- class Left(expression, length, **extra)
返回给定文本字段或表达式的前 length
个字符。
用法示例:
Length
- class Length(expression, **extra)
接受单个文本字段或表达式并返回该值具有的字符数。 如果表达式为空,则长度也将为空。
用法示例:
它也可以注册为转换。 例如:
LPad
- class LPad(expression, length, fill_text=Value(' '), **extra)
返回用 fill_text
填充左侧的给定文本字段或表达式的值,以便结果值为 length
个字符长。 默认 fill_text
是一个空格。
用法示例:
MD5
- class MD5(expression, **extra)
3.0 版中的新功能。
接受单个文本字段或表达式并返回字符串的 MD5 哈希值。
它也可以注册为一个转换,如 Length 中所述。
用法示例:
Ord
- class Ord(expression, **extra)
接受单个文本字段或表达式,并返回该表达式第一个字符的 Unicode 代码点值。 它的工作方式类似于 Python 的 ord()
函数,但如果表达式的长度超过一个字符,则不会引发异常。
它也可以注册为一个转换,如 Length 中所述。 默认查找名称是 ord
。
用法示例:
Repeat
- class Repeat(expression, number, **extra)
返回重复 number
次的给定文本字段或表达式的值。
用法示例:
Replace
- class Replace(expression, text, replacement=Value(), **extra)
将 expression
中所有出现的 text
替换为 replacement
。 默认替换文本是空字符串。 函数的参数区分大小写。
用法示例:
Reverse
- class Reverse(expression, **extra)
2.2 版中的新功能。
接受单个文本字段或表达式并以相反的顺序返回该表达式的字符。
它也可以注册为一个转换,如 Length 中所述。 默认查找名称是 reverse
。
用法示例:
Right
- class Right(expression, length, **extra)
返回给定文本字段或表达式的最后 length
个字符。
用法示例:
SHA1、SHA224、SHA256、SHA384 和 SHA512
- class SHA1(expression, **extra)
- class SHA224(expression, **extra)
- class SHA256(expression, **extra)
- class SHA384(expression, **extra)
- class SHA512(expression, **extra)
3.0 版中的新功能。
接受单个文本字段或表达式并返回字符串的特定哈希值。
它们也可以注册为转换,如 Length 中所述。
用法示例:
甲骨文
Oracle 不支持 SHA224
功能。
StrIndex
- class StrIndex(string, substring, **extra)
返回与 string
中第一次出现 substring
的 1 索引位置相对应的正整数,如果未找到 substring
,则返回 0。
用法示例:
Substr
- class Substr(expression, pos, length=None, **extra)
从从位置 pos
开始的字段或表达式中返回长度为 length
的子字符串。 该位置为 1 索引,因此该位置必须大于 0。 如果 length
是 None
,则将返回字符串的其余部分。
用法示例:
Trim
- class Trim(expression, **extra)
返回删除了前导和尾随空格的给定文本字段或表达式的值。
用法示例:
窗口函数
Window 表达式中有许多函数可用于计算元素的等级或某些行的 Ntile。
CumeDist
- class CumeDist(*expressions, **extra)
计算窗口或分区内某个值的累积分布。 累积分布定义为当前行之前或与之对等的行数除以帧中的总行数。
FirstValue
- class FirstValue(expression, **extra)
返回在窗口框架第一行的行处计算的值,如果不存在这样的值,则返回 None
。
Lag
- class Lag(expression, offset=1, default=None, **extra)
计算偏移offset
的值,如果不存在行,则返回default
。
default
必须与 expression
具有相同的类型,但是,这仅由数据库验证,而不是在 Python 中验证。
Lead
- class Lead(expression, offset=1, default=None, **extra)
计算给定 帧 中的主值。 offset
和 default
都相对于当前行进行评估。
default
必须与 expression
具有相同的类型,但是,这仅由数据库验证,而不是在 Python 中验证。
NthValue
- class NthValue(expression, nth=1, **extra)
计算相对于窗口内偏移量 nth
(必须是正值)的行。 如果不存在行,则返回 None
。
某些数据库可能会以不同的方式处理不存在的第 n 个值。 例如,对于基于字符的表达式,Oracle 返回空字符串而不是 None
。 在这些情况下,Django 不做任何转换。
Ntile
- class Ntile(num_buckets=1, **extra)
为 frame 子句中的每一行计算一个分区,在 1 和 num_buckets
之间尽可能均匀地分布数字。 如果行没有均匀地分成多个桶,一个或多个桶将被更频繁地表示。
PercentRank
- class PercentRank(*expressions, **extra)
计算框架子句中行的百分位等级。 此计算等效于评估:
下表解释了行的百分位排名的计算:
行# | 价值 | 排名 | 计算 | 百分比排名 |
---|---|---|---|---|
1 | 15 | 1 | (1-1)/(7-1) | 0.0000 |
2 | 20 | 2 | (2-1)/(7-1) | 0.1666 |
3 | 20 | 2 | (2-1)/(7-1) | 0.1666 |
4 | 20 | 2 | (2-1)/(7-1) | 0.1666 |
5 | 30 | 5 | (5-1)/(7-1) | 0.6666 |
6 | 30 | 5 | (5-1)/(7-1) | 0.6666 |
7 | 40 | 7 | (7-1)/(7-1) | 1.0000 |
Rank
- class Rank(*expressions, **extra)
与 RowNumber
相比,此功能对窗口中的行进行排序。 计算出的排名包含差距。 使用 DenseRank 计算无间隙的秩。