doc_content
stringlengths 1
386k
| doc_id
stringlengths 5
188
|
|---|---|
function
A class attribute describing the function that will be generated. Specifically, the function will be interpolated as the function placeholder within template. Defaults to None.
|
django.ref.models.expressions#django.db.models.Func.function
|
template
A class attribute, as a format string, that describes the SQL that is generated for this function. Defaults to '%(function)s(%(expressions)s)'. If you’re constructing SQL like strftime('%W', 'date') and need a literal % character in the query, quadruple it (%%%%) in the template attribute because the string is interpolated twice: once during the template interpolation in as_sql() and once in the SQL interpolation with the query parameters in the database cursor.
|
django.ref.models.expressions#django.db.models.Func.template
|
class Abs(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Abs
|
class ACos(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.ACos
|
class ASin(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.ASin
|
class ATan(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.ATan
|
class ATan2(expression1, expression2, **extra)
|
django.ref.models.database-functions#django.db.models.functions.ATan2
|
class Cast(expression, output_field)
|
django.ref.models.database-functions#django.db.models.functions.Cast
|
class Ceil(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Ceil
|
class Chr(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Chr
|
class Coalesce(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Coalesce
|
class Collate(expression, collation)
|
django.ref.models.database-functions#django.db.models.functions.Collate
|
class Concat(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Concat
|
class Cos(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Cos
|
class Cot(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Cot
|
class CumeDist(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.CumeDist
|
class Degrees(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Degrees
|
class DenseRank(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.DenseRank
|
class Exp(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Exp
|
class Extract(expression, lookup_name=None, tzinfo=None, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Extract
|
class ExtractDay(expression, tzinfo=None, **extra)
lookup_name = 'day'
|
django.ref.models.database-functions#django.db.models.functions.ExtractDay
|
class ExtractHour(expression, tzinfo=None, **extra)
lookup_name = 'hour'
|
django.ref.models.database-functions#django.db.models.functions.ExtractHour
|
class ExtractIsoWeekDay(expression, tzinfo=None, **extra)
Returns the ISO-8601 week day with day 1 being Monday and day 7 being Sunday.
lookup_name = 'iso_week_day'
|
django.ref.models.database-functions#django.db.models.functions.ExtractIsoWeekDay
|
class ExtractIsoYear(expression, tzinfo=None, **extra)
Returns the ISO-8601 week-numbering year.
lookup_name = 'iso_year'
|
django.ref.models.database-functions#django.db.models.functions.ExtractIsoYear
|
class ExtractMinute(expression, tzinfo=None, **extra)
lookup_name = 'minute'
|
django.ref.models.database-functions#django.db.models.functions.ExtractMinute
|
class ExtractMonth(expression, tzinfo=None, **extra)
lookup_name = 'month'
|
django.ref.models.database-functions#django.db.models.functions.ExtractMonth
|
class ExtractQuarter(expression, tzinfo=None, **extra)
lookup_name = 'quarter'
|
django.ref.models.database-functions#django.db.models.functions.ExtractQuarter
|
class ExtractSecond(expression, tzinfo=None, **extra)
lookup_name = 'second'
|
django.ref.models.database-functions#django.db.models.functions.ExtractSecond
|
class ExtractWeek(expression, tzinfo=None, **extra)
lookup_name = 'week'
|
django.ref.models.database-functions#django.db.models.functions.ExtractWeek
|
class ExtractWeekDay(expression, tzinfo=None, **extra)
lookup_name = 'week_day'
|
django.ref.models.database-functions#django.db.models.functions.ExtractWeekDay
|
class ExtractYear(expression, tzinfo=None, **extra)
lookup_name = 'year'
|
django.ref.models.database-functions#django.db.models.functions.ExtractYear
|
class FirstValue(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.FirstValue
|
class Floor(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Floor
|
class Greatest(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Greatest
|
class JSONObject(**fields)
|
django.ref.models.database-functions#django.db.models.functions.JSONObject
|
class Lag(expression, offset=1, default=None, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Lag
|
class LastValue(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.LastValue
|
class Lead(expression, offset=1, default=None, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Lead
|
class Least(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Least
|
class Left(expression, length, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Left
|
class Length(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Length
|
class Ln(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Ln
|
class Log(expression1, expression2, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Log
|
class Lower(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Lower
|
class LPad(expression, length, fill_text=Value(' '), **extra)
|
django.ref.models.database-functions#django.db.models.functions.LPad
|
class LTrim(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.LTrim
|
class MD5(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.MD5
|
class Mod(expression1, expression2, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Mod
|
class Now
|
django.ref.models.database-functions#django.db.models.functions.Now
|
class NthValue(expression, nth=1, **extra)
|
django.ref.models.database-functions#django.db.models.functions.NthValue
|
class Ntile(num_buckets=1, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Ntile
|
class NullIf(expression1, expression2)
|
django.ref.models.database-functions#django.db.models.functions.NullIf
|
class Ord(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Ord
|
class PercentRank(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.PercentRank
|
class Pi(**extra)
|
django.ref.models.database-functions#django.db.models.functions.Pi
|
class Power(expression1, expression2, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Power
|
class Radians(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Radians
|
class Random(**extra)
|
django.ref.models.database-functions#django.db.models.functions.Random
|
class Rank(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Rank
|
class Repeat(expression, number, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Repeat
|
class Replace(expression, text, replacement=Value(''), **extra)
|
django.ref.models.database-functions#django.db.models.functions.Replace
|
class Reverse(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Reverse
|
class Right(expression, length, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Right
|
class Round(expression, precision=0, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Round
|
class RowNumber(*expressions, **extra)
|
django.ref.models.database-functions#django.db.models.functions.RowNumber
|
class RPad(expression, length, fill_text=Value(' '), **extra)
|
django.ref.models.database-functions#django.db.models.functions.RPad
|
class RTrim(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.RTrim
|
class SHA1(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.SHA1
|
class SHA224(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.SHA224
|
class SHA256(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.SHA256
|
class SHA384(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.SHA384
|
class SHA512(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.SHA512
|
class Sign(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Sign
|
class Sin(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Sin
|
class Sqrt(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Sqrt
|
class StrIndex(string, substring, **extra)
|
django.ref.models.database-functions#django.db.models.functions.StrIndex
|
class Substr(expression, pos, length=None, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Substr
|
class Tan(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Tan
|
class Trim(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Trim
|
class Trunc(expression, kind, output_field=None, tzinfo=None, is_dst=None, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Trunc
|
class TruncDate(expression, tzinfo=None, **extra)
lookup_name = 'date'
output_field = DateField()
Changed in Django 3.2: The tzinfo parameter was added.
|
django.ref.models.database-functions#django.db.models.functions.TruncDate
|
class TruncDay(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'day'
|
django.ref.models.database-functions#django.db.models.functions.TruncDay
|
class TruncHour(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'hour'
|
django.ref.models.database-functions#django.db.models.functions.TruncHour
|
class TruncMinute(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'minute'
|
django.ref.models.database-functions#django.db.models.functions.TruncMinute
|
class TruncMonth(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'month'
|
django.ref.models.database-functions#django.db.models.functions.TruncMonth
|
class TruncQuarter(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'quarter'
|
django.ref.models.database-functions#django.db.models.functions.TruncQuarter
|
class TruncSecond(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'second'
|
django.ref.models.database-functions#django.db.models.functions.TruncSecond
|
class TruncTime(expression, tzinfo=None, **extra)
lookup_name = 'time'
output_field = TimeField()
Changed in Django 3.2: The tzinfo parameter was added.
|
django.ref.models.database-functions#django.db.models.functions.TruncTime
|
class TruncWeek(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
Truncates to midnight on the Monday of the week.
kind = 'week'
|
django.ref.models.database-functions#django.db.models.functions.TruncWeek
|
class TruncYear(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
kind = 'year'
|
django.ref.models.database-functions#django.db.models.functions.TruncYear
|
class Upper(expression, **extra)
|
django.ref.models.database-functions#django.db.models.functions.Upper
|
class GenericIPAddressField(protocol='both', unpack_ipv4=False, **options)
|
django.ref.models.fields#django.db.models.GenericIPAddressField
|
GenericIPAddressField.protocol
Limits valid inputs to the specified protocol. Accepted values are 'both' (default), 'IPv4' or 'IPv6'. Matching is case insensitive.
|
django.ref.models.fields#django.db.models.GenericIPAddressField.protocol
|
GenericIPAddressField.unpack_ipv4
Unpacks IPv4 mapped addresses like ::ffff:192.0.2.1. If this option is enabled that address would be unpacked to 192.0.2.1. Default is disabled. Can only be used when protocol is set to 'both'.
|
django.ref.models.fields#django.db.models.GenericIPAddressField.unpack_ipv4
|
get_lookup(lookup_name)
Must return the lookup named lookup_name. For instance, by returning self.output_field.get_lookup(lookup_name).
|
django.ref.models.lookups#django.db.models.get_lookup
|
get_transform(transform_name)
Must return the lookup named transform_name. For instance, by returning self.output_field.get_transform(transform_name).
|
django.ref.models.lookups#django.db.models.get_transform
|
class ImageField(upload_to=None, height_field=None, width_field=None, max_length=100, **options)
|
django.ref.models.fields#django.db.models.ImageField
|
ImageField.height_field
Name of a model field which will be auto-populated with the height of the image each time the model instance is saved.
|
django.ref.models.fields#django.db.models.ImageField.height_field
|
ImageField.width_field
Name of a model field which will be auto-populated with the width of the image each time the model instance is saved.
|
django.ref.models.fields#django.db.models.ImageField.width_field
|
class Index(*expressions, fields=(), name=None, db_tablespace=None, opclasses=(), condition=None, include=None)
Creates an index (B-Tree) in the database.
|
django.ref.models.indexes#django.db.models.Index
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.