Skip to content

Level#

Bases: SsasRenameRecord

A level in a hierarchy. For example, in a hierarchy of "Date", the levels could be "Year", "Month", and "Day".

SSAS spec: Microsoft

Source code in pbi_core/ssas/model_tables/level/level.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@define()
class Level(SsasRenameRecord):
    """A level in a hierarchy. For example, in a hierarchy of "Date", the levels could be "Year", "Month", and "Day".

    SSAS spec: [Microsoft](https://learn.microsoft.com/en-us/openspecs/sql_server_protocols/ms-ssas-t/a010d75e-3b68-4825-898f-62fdeab4557f)
    """

    column_id: int = field(eq=True)
    description: str | None = field(default=None, eq=True)
    """A description of the level, which may be used in the hover tooltip in edit mode"""
    hierarchy_id: int = field(eq=True)
    name: str = field(eq=True)
    """The name of the level, e.g. "Year", "Quarter", "Month", "Day" in a Date hierarchy."""
    ordinal: int = field(eq=True)

    lineage_tag: UUID = field(factory=uuid4, eq=True, repr=False)
    source_lineage_tag: UUID = field(factory=uuid4, eq=True, repr=False)

    modified_time: Final[datetime.datetime] = field(eq=False, on_setattr=setters.frozen, repr=False)

    _commands: RenameCommands = field(default=SsasCommands.level, init=False, repr=False, eq=False)

    def column(self) -> "Column":
        return self._tabular_model.columns.find({"id": self.column_id})

    def hierarchy(self) -> "Hierarchy":
        return self._tabular_model.hierarchies.find({"id": self.hierarchy_id})

    def parents_base(self) -> frozenset["LinkedEntity"]:
        return LinkedEntity.from_iter({self.column()}, by="column") | LinkedEntity.from_iter(
            {self.hierarchy()},
            by="hierarchy",
        )

    def children_base(self) -> frozenset["LinkedEntity"]:
        return LinkedEntity.from_iter(self.annotations(), by="annotation")

description class-attribute instance-attribute #

description: str | None = field(default=None, eq=True)

A description of the level, which may be used in the hover tooltip in edit mode

name class-attribute instance-attribute #

name: str = field(eq=True)

The name of the level, e.g. "Year", "Quarter", "Month", "Day" in a Date hierarchy.