pypika.queries module

class pypika.queries.AliasedQuery(name, query=None)

Bases: pypika.queries.Selectable

get_sql(**kwargs)

class pypika.queries.Column(column_name, column_type=None)

Bases: object

get_sql(**kwargs)

class pypika.queries.CreateQueryBuilder(dialect=None)

Bases: object

Query builder used to build CREATE queries.

ALIAS_QUOTE_CHAR = None

QUOTE_CHAR = '"'

SECONDARY_QUOTE_CHAR = "'"

as_select(*args, **kwargs)

columns(*args, **kwargs)

create_table(*args, **kwargs)

get_sql(**kwargs)

temporary(*args, **kwargs)

class pypika.queries.Database(name, parent=None)

Bases: pypika.queries.Schema

class pypika.queries.Join(item, how)

Bases: object

get_sql(**kwargs)

replace_table(*args, **kwargs)

validate(_from, _joins)

class pypika.queries.JoinOn(item, how, criteria, collate=None)

Bases: pypika.queries.Join

get_sql(**kwargs)

replace_table(*args, **kwargs)

validate(_from, _joins)

class pypika.queries.JoinUsing(item, how, fields)

Bases: pypika.queries.Join

get_sql(**kwargs)

replace_table(*args, **kwargs)

validate(_from, _joins)

class pypika.queries.Joiner(query, item, how, type_label)

Bases: object

cross()

Return cross join

on(criterion, collate=None)

on_field(*fields)

using(*fields)

class pypika.queries.Query

Bases: object

Query is the primary class and entry point in pypika. It is used to build queries iteratively using the builder design pattern.

This class is immutable.

classmethod create_table(table)

Query builder entry point. Initializes query building and sets the table name to be created. When using this function, the query becomes a CREATE statement.

Parameters:table – An instance of a Table object or a string table name. Returns:CreateQueryBuilder

classmethod from_(table)

Query builder entry point. Initializes query building and sets the table to select from. When using this function, the query becomes a SELECT query.

Parameters:table –

Type: Table or str

An instance of a Table object or a string table name.

:returns QueryBuilder

classmethod into(table)

Query builder entry point. Initializes query building and sets the table to insert into. When using this function, the query becomes an INSERT query.

Parameters:table –

Type: Table or str

An instance of a Table object or a string table name.

:returns QueryBuilder

classmethod select(*terms)

Query builder entry point. Initializes query building without a table and selects fields. Useful when testing SQL functions.

Parameters:terms –

Type: list[expression]

A list of terms to select. These can be any type of int, float, str, bool, or Term. They cannot be a Field unless the function Query.from_ is called first.

:returns QueryBuilder

classmethod update(table)

Query builder entry point. Initializes query building and sets the table to update. When using this function, the query becomes an UPDATE query.

Parameters:table –

Type: Table or str

An instance of a Table object or a string table name.

:returns QueryBuilder

classmethod with_(table, name)

class pypika.queries.QueryBuilder(dialect=None, wrap_union_queries=True, wrapper_cls=<class 'pypika.terms.ValueWrapper'>)

Bases: pypika.queries.Selectable, pypika.terms.Term

Query Builder is the main class in pypika which stores the state of a query and offers functions which allow the state to be branched immutably.

ALIAS_QUOTE_CHAR = None

QUOTE_CHAR = '"'

SECONDARY_QUOTE_CHAR = "'"

columns(*args, **kwargs)

cross_join(item)

delete(*args, **kwargs)

distinct(*args, **kwargs)

do_join(join)

fields()

force_index(*args, **kwargs)

from_(*args, **kwargs)

get_sql(with_alias=False, subquery=False, **kwargs)

groupby(*args, **kwargs)

having(*args, **kwargs)

ignore(*args, **kwargs)

inner_join(item)

insert(*args, **kwargs)

into(*args, **kwargs)

is_joined(table)

join(*args, **kwargs)

left_join(item)

limit(*args, **kwargs)

offset(*args, **kwargs)

orderby(*args, **kwargs)

outer_join(item)

prewhere(*args, **kwargs)

replace(*args, **kwargs)

replace_table(*args, **kwargs)

right_join(item)

rollup(*args, **kwargs)

select(*args, **kwargs)

set(*args, **kwargs)

union(*args, **kwargs)

union_all(*args, **kwargs)

update(*args, **kwargs)

where(*args, **kwargs)

with_(*args, **kwargs)

with_totals(*args, **kwargs)

class pypika.queries.Schema(name, parent=None)

Bases: object

get_sql(quote_char=None, **kwargs)

class pypika.queries.Selectable(alias)

Bases: object

as_(*args, **kwargs)

field(name)

star

class pypika.queries.Table(name, schema=None, alias=None)

Bases: pypika.queries.Selectable

get_sql(**kwargs)

insert(*terms)

Perform an INSERT operation on the current table

Parameters:terms –

Type: list[expression]

A list of terms to select. These can be any type of int, float, str, bool or any other valid data

Returns:QueryBuilder

select(*terms)

Perform a SELECT operation on the current table

Parameters:terms –

Type: list[expression]

A list of terms to select. These can be any type of int, float, str, bool or Term or a Field.

Returns:QueryBuilder

update()

Perform an UPDATE operation on the current table

Returns:QueryBuilder

pypika.queries.make_columns(*names)

Shortcut to create many columns. If names param is a tuple, the first position will refer to the name while the second will be its type. Any other data structure will be treated as a whole as the name.

pypika.queries.make_tables(*names, **kwargs)

Shortcut to create many tables. If names param is a tuple, the first position will refer to the _table_name while the second will be its alias. Any other data structure will be treated as a whole as the _table_name.