pypika.terms module

class pypika.terms.AggregateFunction(name, *args, **kwargs)

Bases: pypika.terms.Function

is_aggregate = True

class pypika.terms.AnalyticFunction(name, *args, **kwargs)

Bases: pypika.terms.Function

get_function_sql(**kwargs)

get_partition_sql(**kwargs)

is_analytic = True

orderby(*args, **kwargs)

over(*args, **kwargs)

class pypika.terms.ArithmeticExpression(operator, left, right, alias=None)

Bases: pypika.terms.Term

Wrapper for an arithmetic function. Can be simple with two terms or complex with nested terms. Order of operations are also preserved.

add_order = [<Arithmetic.add: '+'>, <Arithmetic.sub: '-'>]

fields()

for_(*args, **kwargs)

get_sql(with_alias=False, **kwargs)

is_aggregate

mul_order = [<Arithmetic.mul: '*'>, <Arithmetic.div: '/'>]

tables_

class pypika.terms.BasicCriterion(comparator, left, right, alias=None)

Bases: pypika.terms.Criterion

fields()

for_(*args, **kwargs)

get_sql(with_alias=False, **kwargs)

tables_

class pypika.terms.BetweenCriterion(term, start, end, alias=None)

Bases: pypika.terms.Criterion

fields()

for_(*args, **kwargs)

get_sql(**kwargs)

tables_

class pypika.terms.Case(alias=None)

Bases: pypika.terms.Term

else_(*args, **kwargs)

fields()

get_sql(with_alias=False, **kwargs)

is_aggregate

when(*args, **kwargs)

class pypika.terms.ComplexCriterion(comparator, left, right, alias=None)

Bases: pypika.terms.BasicCriterion

fields()

get_sql(subcriterion=False, **kwargs)

needs_brackets(term)

class pypika.terms.ContainsCriterion(term, container, alias=None)

Bases: pypika.terms.Criterion

fields()

get_sql(**kwargs)

negate()

class pypika.terms.Criterion(alias=None)

Bases: pypika.terms.Term

fields()

get_sql()

class pypika.terms.Field(name, alias=None, table=None)

Bases: pypika.terms.Term

for_(*args, **kwargs)

get_sql(with_alias=False, with_namespace=False, quote_char=None, **kwargs)

tables_

class pypika.terms.Function(name, *args, **kwargs)

Bases: pypika.terms.Term

fields()

for_(*args, **kwargs)

get_function_sql(**kwargs)

get_special_params_sql(**kwargs)

get_sql(with_alias=False, with_namespace=False, quote_char=None, **kwargs)

tables_

class pypika.terms.IgnoreNullsAnalyticFunction(name, *args, **kwargs)

Bases: pypika.terms.AnalyticFunction

get_special_params_sql(**kwargs)

ignore_nulls(*args, **kwargs)

class pypika.terms.Interval(years=0, months=0, days=0, hours=0, minutes=0, seconds=0, microseconds=0, quarters=0, weeks=0, dialect=None)

Bases: object

fields()

get_sql(**kwargs)

labels = ['YEAR', 'MONTH', 'DAY', 'HOUR', 'MINUTE', 'SECOND', 'MICROSECOND']

trim_pattern = <_sre.SRE_Pattern object>

units = ['years', 'months', 'days', 'hours', 'minutes', 'seconds', 'microseconds']

class pypika.terms.Mod(term, modulus, alias=None)

Bases: pypika.terms.Function

class pypika.terms.Not(term)

Bases: object

fields()

get_sql(**kwargs)

class pypika.terms.NullCriterion(term, alias=None)

Bases: pypika.terms.Criterion

fields()

for_(*args, **kwargs)

get_sql(**kwargs)

tables_

class pypika.terms.NullValue(alias=None)

Bases: pypika.terms.Term

fields()

get_sql(**kwargs)

class pypika.terms.Pow(term, exponent, alias=None)

Bases: pypika.terms.Function

class pypika.terms.Rollup(*terms)

Bases: pypika.terms.Function

class pypika.terms.Star(table=None)

Bases: pypika.terms.Field

get_sql(with_alias=False, with_namespace=False, quote_char=None, **kwargs)

class pypika.terms.Term(alias=None)

Bases: object

as_(*args, **kwargs)

between(lower, upper)

bin_regex(pattern)

eq(other)

fields()

get_sql()

gt(other)

gte(other)

is_aggregate = False

isin(arg)

isnull()

like(expr)

lt(other)

lte(other)

ne(other)

negate()

notin(arg)

notnull()

regex(pattern)

tables_

class pypika.terms.Tuple(*values)

Bases: pypika.terms.Term

fields()

get_sql(**kwargs)

class pypika.terms.ValueWrapper(value)

Bases: pypika.terms.Term

fields()

get_sql(**kwargs)

is_aggregate = None

class pypika.terms.WindowFrameAnalyticFunction(name, *args, **kwargs)

Bases: pypika.terms.AnalyticFunction

class Edge(value=None)

get_frame_sql()

get_partition_sql(**kwargs)

range(*args, **kwargs)

rows(*args, **kwargs)