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()

get_sql(with_alias=False, **kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

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

replace_table(*args, **kwargs)

tables_

class pypika.terms.Array(*values)

Bases: pypika.terms.Tuple

get_sql(**kwargs)

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

Bases: pypika.terms.Criterion

fields()

get_sql(quote_char='"', with_alias=False, **kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

replace_table(*args, **kwargs)

tables_

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

Bases: pypika.terms.Criterion

fields()

get_sql(**kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

replace_table(*args, **kwargs)

tables_

class pypika.terms.BitwiseAndCriterion(term, value, alias=None)

Bases: pypika.terms.Criterion

fields()

get_sql(**kwargs)

replace_table(*args, **kwargs)

tables_

class pypika.terms.Bracket(term)

Bases: pypika.terms.Tuple

get_sql(**kwargs)

class pypika.terms.Case(alias=None)

Bases: pypika.terms.Term

else_(*args, **kwargs)

fields()

get_sql(with_alias=False, **kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

replace_table(*args, **kwargs)

tables_

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(subquery=None, **kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

negate()

replace_table(*args, **kwargs)

tables_

class pypika.terms.Criterion(alias=None)

Bases: pypika.terms.Term

static all(terms=())

static any(terms=())

fields()

get_sql()

class pypika.terms.CustomFunction(name, params=None)

Bases: object

class pypika.terms.EmptyCriterion

Bases: object

is_aggregate = None

tables_ = {}

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

Bases: pypika.terms.Criterion, pypika.terms.JSON

fields()

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

replace_table(*args, **kwargs)

tables_

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

Bases: pypika.terms.Criterion

fields()

get_function_sql(**kwargs)

get_special_params_sql(**kwargs)

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

is_aggregate

This is a shortcut that assumes if a function has a single argument and that argument is aggregated, then this function is also aggregated. A more sophisticated approach is needed, however it is unclear how that might work. :returns:

True if the function accepts one argument and that argument is aggregate.

replace_table(*args, **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.Index(name, alias=None)

Bases: pypika.terms.Term

get_sql(quote_char=None, **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']

tables_

templates = {<Dialects.MYSQL: 'mysql'>: 'INTERVAL {expr} {unit}', <Dialects.POSTGRESQL: 'postgressql'>: "INTERVAL '{expr} {unit}'", <Dialects.REDSHIFT: 'redshift'>: "INTERVAL '{expr} {unit}'", <Dialects.VERTICA: 'vertica'>: "INTERVAL '{expr} {unit}'", <Dialects.ORACLE: 'oracle'>: "INTERVAL '{expr}' {unit}"}

trim_pattern = re.compile('(^0+\\.)|(\\.0+$)|(^[0\\-.: ]+[\\-: ])|([\\-:. ][0\\-.: ]+$)')

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

class pypika.terms.JSON(value, alias=None)

Bases: pypika.terms.Term

contained_by(other)

contains(other)

get_json_value(key_or_index: Union[str, int])

get_path_json_value(path_json: str)

get_path_text_value(path_json: str)

get_sql(secondary_quote_char="'", **kwargs)

get_text_value(key_or_index: Union[str, int])

has_any_keys(other: Iterable[T_co])

has_key(other)

has_keys(other: Iterable[T_co])

table = None

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

Bases: pypika.terms.Function

class pypika.terms.Negative(term)

Bases: pypika.terms.Term

get_sql(**kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

class pypika.terms.NestedCriterion(comparator, nested_comparator, left, right, nested, alias=None)

Bases: pypika.terms.Criterion

fields()

get_sql(with_alias=False, **kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

replace_table(*args, **kwargs)

tables_

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

Bases: pypika.terms.Criterion

fields()

get_sql(**kwargs)

replace_table(*args, **kwargs)

tables_

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

Bases: pypika.terms.Criterion

fields()

get_sql(**kwargs)

replace_table(*args, **kwargs)

tables_

class pypika.terms.NullValue(alias=None)

Bases: pypika.terms.Term

fields()

get_sql(**kwargs)

class pypika.terms.Parameter(placeholder)

Bases: pypika.terms.Term

fields()

get_sql(**kwargs)

is_aggregate = None

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

Bases: pypika.terms.Function

class pypika.terms.PseudoColumn(name)

Bases: pypika.terms.Term

Represents a pseudo column (a “column” which yields a value when selected but is not actually a real table column).

fields()

get_sql(**kwargs)

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)

tables_

class pypika.terms.Term(alias=None)

Bases: object

as_(*args, **kwargs)

between(lower, upper)

bin_regex(pattern)

bitwiseand(value)

eq(other)

fields()

get_sql(**kwargs)

gt(other)

gte(other)

ilike(expr)

is_aggregate = False

isin(arg)

isnull()

like(expr)

lt(other)

lte(other)

ne(other)

negate()

not_ilike(expr)

not_like(expr)

notin(arg)

notnull()

regex(pattern)

replace_table(current_table, new_table)

Replaces all occurrences of the specified table with the new table. Useful when reusing fields across queries. The base implementation returns self because not all terms have a table property.

Parameters:

• current_table – The table to be replaced.
• new_table – The table to replace with.

Returns:

Self.

tables_

static wrap_constant(val, wrapper_cls=None)

Used for wrapping raw inputs such as numbers in Criterions and Operator.

For example, the expression F(‘abc’)+1 stores the integer part in a ValueWrapper object.

Parameters:

• val – Any value.
• wrapper_cls – A pypika class which wraps a constant value so it can be handled as a component of the query.

Returns:

Raw string, number, or decimal values will be returned in a ValueWrapper. Fields and other parts of the querybuilder will be returned as inputted.

static wrap_json(val, wrapper_cls=None)

class pypika.terms.Tuple(*values)

Bases: pypika.terms.Criterion

fields()

get_sql(**kwargs)

is_aggregate

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

replace_table(*args, **kwargs)

class pypika.terms.ValueWrapper(value, alias=None)

Bases: pypika.terms.Term

fields()

get_sql(quote_char=None, secondary_quote_char="'", **kwargs)

get_value_sql(**kwargs)

is_aggregate = None

class pypika.terms.Values(field)

Bases: pypika.terms.Term

get_sql(quote_char=None, **kwargs)

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

Bases: pypika.terms.AnalyticFunction

class Edge(value=None)

Bases: object

get_frame_sql()

get_partition_sql(**kwargs)

range(*args, **kwargs)

rows(*args, **kwargs)