atoti.function.lookup module#

atoti.lookup(column, mapping, /)#

Return a measure equal to a get-by-key query on the given table column.

Parameters:

column (Column) – The column to get the value from.
mapping (Condition[ColumnCoordinates, Literal['eq'], Union[Constant, MeasureConvertibleCoordinates, MeasureOperation], Optional[Literal['and']]]) – A condition made of equality checks on all the keys of the passed column’s Table.

Return type:

MeasureDescription

Example

>>> budget_dataframe = pd.DataFrame(
...     {
...         "Position": [
...             "Sales manager 1",
...             "Sales person 1",
...             "Sales person 2",
...             "Sales manager 2",
...             "Sales person 3",
...         ],
...         "Budget": [20000, 15000, 10000, 40000, 12000],
...     }
... )
>>> organization_dataframe = pd.DataFrame(
...     {
...         "Supervisors 1": [
...             "Sales manager 1",
...             "Sales manager 2",
...         ],
...         "Supervisors 2": ["Sales person 1", "Sales person 3"],
...         "Supervisors 3": ["Sales person 2", ""],
...     }
... )
>>> budget_table = session.read_pandas(
...     budget_dataframe, table_name="Budget", keys=["Position"]
... )
>>> organization_table = session.read_pandas(
...     organization_dataframe,
...     table_name="Company organization",
...     keys=["Supervisors 1"],
... )
>>> cube = session.create_cube(organization_table, mode="manual")
>>> h, l, m = cube.hierarchies, cube.levels, cube.measures
>>> h["Organization level"] = [
...     organization_table["Supervisors 1"],
...     organization_table["Supervisors 2"],
...     organization_table["Supervisors 3"],
... ]
>>> m["Position"] = tt.where(
...     (~l["Supervisors 1"].isnull()) & (l["Supervisors 2"].isnull()),
...     l["Supervisors 1"],
...     tt.where(
...         (~l["Supervisors 2"].isnull()) & (l["Supervisors 3"].isnull()),
...         l["Supervisors 2"],
...         l["Supervisors 3"],
...     ),
... )
>>> cube.query(m["Position"], levels=[l["Supervisors 3"]], include_totals=True)
                                                      Position
Supervisors 1   Supervisors 2  Supervisors 3
Sales manager 1                                Sales manager 1
                Sales person 1                  Sales person 1
                               Sales person 2   Sales person 2
Sales manager 2                                Sales manager 2
                Sales person 3                  Sales person 3
                               N/A                         N/A
>>> m["Position budget"] = tt.lookup(
...     budget_table["Budget"], budget_table["Position"] == m["Position"]
... )
>>> cube.query(
...     m["Position budget"], levels=[l["Supervisors 3"]], include_totals=True
... )
                                              Position budget
Supervisors 1   Supervisors 2  Supervisors 3
Sales manager 1                                        20,000
                Sales person 1                         15,000
                               Sales person 2          10,000
Sales manager 2                                        40,000
                Sales person 3                         12,000