cycquery.ops.ConditionIn¶

class ConditionIn(col, values, not_=False, binarize_col=None, **cond_kwargs)[source]¶

Filter rows based on having a value in list of values.

Parameters:

col (str) – Column name on which to condition.
values (Union[Any, List[Any]]) – Values in which the column value must be.
not – Take negation of condition.
binarize_col (Optional[str]) – If specified, create a Boolean column of name binarize_col instead of filtering.
**cond_kwargs (Any) – Optional keyword arguments for processing the condition.

Examples

>>> ConditionIn("col1", [1, 2])(table)
>>> ConditionIn("col1", [1, 2], binarize_col="col1_bool")(table)

Methods

__call__(table, return_cond=False)[source]¶

Process the table.

Parameters:

table (Union[Select, Subquery, Table, DBTable]) – Table on which to perform the operation.
return_cond (bool) – Return the condition instead of filtering.

Returns:

Processed table.

Return type:

sqlalchemy.sql.selectable.Subquery