Skip to content

orcalib.orca_expr#

This module contains classes used for generating SQL expressions in Orca for filtering and sorting data.

Note

This module is not intended to be used directly. Instead, it is used in the TableHandle class to generate SQL expressions.

Operable #

__eq__ #

1
__eq__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__ne__ #

1
__ne__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__lt__ #

1
__lt__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__le__ #

1
__le__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__gt__ #

1
__gt__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__ge__ #

1
__ge__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__add__ #

1
__add__(value)

Parameters:

  • value (OperableType) –

    Value to add

__radd__ #

1
__radd__(value)

Parameters:

  • value (OperableType) –

    Value to add

__sub__ #

1
__sub__(value)

Parameters:

  • value (OperableType) –

    Value to subtract

__rsub__ #

1
__rsub__(value)

Parameters:

  • value (OperableType) –

    Value to subtract

__mul__ #

1
__mul__(value)

Parameters:

  • value (OperableType) –

    Value to multiply

__rmul__ #

1
__rmul__(value)

Parameters:

  • value (OperableType) –

    Value to multiply

__truediv__ #

1
__truediv__(value)

Parameters:

  • value (OperableType) –

    Value to divide

__rtruediv__ #

1
__rtruediv__(value)

Parameters:

  • value (OperableType) –

    Value to divide

__and__ #

1
__and__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__or__ #

1
__or__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

OrcaExpr #

1
OrcaExpr(op, args)

Bases: Operable

Orca expression class. This class is used to represent expressions in Orca.

Parameters:

  • op (str) –

    The operation to perform

  • args (tuple[OperableType, ...]) –

    The arguments to the operation

__eq__ #

1
__eq__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__ne__ #

1
__ne__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__lt__ #

1
__lt__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__le__ #

1
__le__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__gt__ #

1
__gt__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__ge__ #

1
__ge__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__add__ #

1
__add__(value)

Parameters:

  • value (OperableType) –

    Value to add

__radd__ #

1
__radd__(value)

Parameters:

  • value (OperableType) –

    Value to add

__sub__ #

1
__sub__(value)

Parameters:

  • value (OperableType) –

    Value to subtract

__rsub__ #

1
__rsub__(value)

Parameters:

  • value (OperableType) –

    Value to subtract

__mul__ #

1
__mul__(value)

Parameters:

  • value (OperableType) –

    Value to multiply

__rmul__ #

1
__rmul__(value)

Parameters:

  • value (OperableType) –

    Value to multiply

__truediv__ #

1
__truediv__(value)

Parameters:

  • value (OperableType) –

    Value to divide

__rtruediv__ #

1
__rtruediv__(value)

Parameters:

  • value (OperableType) –

    Value to divide

__and__ #

1
__and__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__or__ #

1
__or__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

as_serializable #

1
as_serializable()

Serialize the expression to a format that can be sent to the server

ColumnHandle #

1
ColumnHandle(db_name, table_name, column_name)

Bases: Operable

Handle for a column in a table.

Parameters:

  • db_name (str) –

    Name of the database

  • table_name (str) –

    Name of the table

  • column_name (str) –

    Name of the column

ASC property #

1
ASC

Return a tuple of the column name and the ascending order. This can be used with TableHandle.order_by to sort this column in ascending order

DESC property #

1
DESC

Return a tuple of the column name and the descending order. This can be used with TableHandle.order_by to sort this column in descending order

__eq__ #

1
__eq__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__ne__ #

1
__ne__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__lt__ #

1
__lt__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__le__ #

1
__le__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__gt__ #

1
__gt__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__ge__ #

1
__ge__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__add__ #

1
__add__(value)

Parameters:

  • value (OperableType) –

    Value to add

__radd__ #

1
__radd__(value)

Parameters:

  • value (OperableType) –

    Value to add

__sub__ #

1
__sub__(value)

Parameters:

  • value (OperableType) –

    Value to subtract

__rsub__ #

1
__rsub__(value)

Parameters:

  • value (OperableType) –

    Value to subtract

__mul__ #

1
__mul__(value)

Parameters:

  • value (OperableType) –

    Value to multiply

__rmul__ #

1
__rmul__(value)

Parameters:

  • value (OperableType) –

    Value to multiply

__truediv__ #

1
__truediv__(value)

Parameters:

  • value (OperableType) –

    Value to divide

__rtruediv__ #

1
__rtruediv__(value)

Parameters:

  • value (OperableType) –

    Value to divide

__and__ #

1
__and__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

__or__ #

1
__or__(value)

Parameters:

  • value (OperableType) –

    Value to compare with

as_serializable #

1
as_serializable()

Serialize the column handle to a format that can be sent to the server