atoti.query.hierarchy module

class atoti.query.hierarchy.QueryHierarchy(_name, _dimension, _levels, _slicing)

Bases: atoti._base._base_hierarchy.BaseHierarchy[atoti._mappings.ImmutableMapping[str, atoti.query.level.QueryLevel]]

Hierarchy of a query cube.

property dimension

Name of the dimension of the hierarchy.

Return type

str

isin(*member_paths)

Return a condition to check that the hierarchy is on one of the given members.

Considering hierarchy_1 containing level_1 and level_2, hierarchy_1.isin((a,), (b, x)) is equivalent to (level_1 == a) OR ((level_1 == b) AND (level_2 == x)).

Parameters

members – One or more members expressed as tuples on which the hierarchy should be. Each element in a tuple corresponds to a level of the hierarchy, from the shallowest to the deepest.

Example

>>> df = pd.DataFrame(
...     columns=["Country", "City", "Price"],
...     data=[
...         ("Germany", "Berlin", 150.0),
...         ("Germany", "Hamburg", 120.0),
...         ("United Kingdom", "London", 240.0),
...         ("United States", "New York", 270.0),
...         ("France", "Paris", 200.0),
...     ],
... )
>>> store = session.read_pandas(
...     df, keys=["Country", "City"], store_name="isin example"
... )
>>> cube = session.create_cube(store)
>>> h, lvl, m = cube.hierarchies, cube.levels, cube.measures
>>> h["Geography"] = [lvl["Country"], lvl["City"]]
>>> m["Price.SUM in Germany and Paris"] = tt.filter(
...     m["Price.SUM"],
...     h["Geography"].isin(("Germany",), ("France", "Paris")),
... )
>>> cube.query(
...     m["Price.SUM"],
...     m["Price.SUM in Germany and Paris"],
...     levels=lvl["Geography", "City"],
... )
                        Price.SUM Price.SUM in Germany and Paris
Country        City
France         Paris       200.00                         200.00
Germany        Berlin      150.00                         150.00
               Hamburg     120.00                         120.00
United Kingdom London      240.00
United States  New York    270.00

Return type

HierarchyIsInCondition

property levels

Levels of the hierarchy.

Return type

ImmutableMapping[str, QueryLevel]

property name

Name of the hierarchy.

Return type

str

property slicing

Whether the hierarchy is slicing or not.

Return type

bool