pypika.functions module

Package for SQL functions wrappers

class pypika.functions.Abs(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.ApproximatePercentile(term, percentile, alias=None)[source]

Bases: pypika.terms.AggregateFunction

get_special_params_sql(**kwargs)[source]
class pypika.functions.Ascii(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Avg(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.Bin(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Cast(term, as_type, alias=None)[source]

Bases: pypika.terms.Function

get_special_params_sql(**kwargs)[source]
class pypika.functions.Coalesce(term, *default_values, **kwargs)[source]

Bases: pypika.terms.Function

class pypika.functions.Concat(*terms, **kwargs)[source]

Bases: pypika.terms.Function

class pypika.functions.Convert(term, encoding, alias=None)[source]

Bases: pypika.terms.Function

get_special_params_sql(**kwargs)[source]
class pypika.functions.Count(param, alias=None)[source]

Bases: pypika.functions.DistinctOptionFunction

class pypika.functions.CurDate(alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.CurTime(alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.CurTimestamp(alias=None)[source]

Bases: pypika.terms.Function

get_function_sql(**kwargs)[source]
class pypika.functions.Date(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.DateAdd(date_part, interval, term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.DateDiff(interval, start_date, end_date, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.DistinctOptionFunction(name, *args, **kwargs)[source]

Bases: pypika.terms.AggregateFunction

distinct(*args, **kwargs)
get_function_sql(**kwargs)[source]
class pypika.functions.Extract(date_part, field, alias=None)[source]

Bases: pypika.terms.Function

get_special_params_sql(**kwargs)[source]
class pypika.functions.First(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.Floor(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.IfNull(condition, term, **kwargs)[source]

Bases: pypika.terms.Function

class pypika.functions.Insert(term, start, stop, subterm, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.IsNull(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Last(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.Length(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Lower(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Max(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.Min(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.NVL(condition, term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Now(alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.NullIf(term, condition, **kwargs)[source]

Bases: pypika.terms.Function

class pypika.functions.RegexpLike(term, pattern, modifiers=None, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.RegexpMatches(term, pattern, modifiers=None, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Reverse(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Signed(term, alias=None)[source]

Bases: pypika.functions.Cast

class pypika.functions.SplitPart(term, delimiter, index, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Sqrt(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Std(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.StdDev(term, alias=None)[source]

Bases: pypika.terms.AggregateFunction

class pypika.functions.Substring(term, start, stop, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Sum(term, alias=None)[source]

Bases: pypika.functions.DistinctOptionFunction

class pypika.functions.TimeDiff(start_time, end_time, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Timestamp(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.TimestampAdd(date_part, interval, term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.ToChar(term, as_type, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.ToDate(value, format_mask, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Trim(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.Unsigned(term, alias=None)[source]

Bases: pypika.functions.Cast

class pypika.functions.Upper(term, alias=None)[source]

Bases: pypika.terms.Function

class pypika.functions.UtcTimestamp(alias=None)[source]

Bases: pypika.terms.Function