Skip to content

Annotation#

Bases: SsasRenameRecord

TBD.

SSAS spec: Microsoft

Source code in pbi_core/ssas/model_tables/annotation/annotation.py 
12
13
14
15
16
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@define()
class Annotation(SsasRenameRecord):
    """TBD.

    SSAS spec: [Microsoft](https://learn.microsoft.com/en-us/openspecs/sql_server_protocols/ms-ssas-t/7a16a837-cb88-4cb2-a766-a97c4d0e1f43)
    """

    object_id: int = field(eq=True)
    object_type: ObjectType = field(eq=True)
    name: str = field(eq=True)
    value: str | None = field(eq=True, default=None)

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

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

    def parents_base(self) -> frozenset[LinkedEntity]:
        """Returns the parent object the annotation is describing."""
        return LinkedEntity.from_iter({self.object()}, by="object")

    def object(self) -> SsasTable:
        """Returns the object the annotation is describing.

        Raises:
            TypeError: When the Object Type doesn't map to a know SSAS entity type

        """
        mapper = {
            ObjectType.ATTRIBUTE_HIERARCHY: self._tabular_model.attribute_hierarchies.find,
            ObjectType.CALCULATION_GROUP: self._tabular_model.calculation_groups.find,
            ObjectType.COLUMN: self._tabular_model.columns.find,
            ObjectType.COLUMN_PERMISSION: self._tabular_model.column_permissions.find,
            ObjectType.CULTURE: self._tabular_model.cultures.find,
            ObjectType.DATASOURCE: self._tabular_model.data_sources.find,
            ObjectType.EXPRESSION: self._tabular_model.expressions.find,
            ObjectType.HIERARCHY: self._tabular_model.hierarchies.find,
            ObjectType.KPI: self._tabular_model.kpis.find,
            ObjectType.LEVEL: self._tabular_model.levels.find,
            ObjectType.LINGUISTIC_METADATA: self._tabular_model.linguistic_metadata.find,
            ObjectType.MEASURE: self._tabular_model.measures.find,
            ObjectType.MODEL: lambda _x: self._tabular_model.model,
            ObjectType.PARTITION: self._tabular_model.partitions.find,
            ObjectType.PERSPECTIVE: self._tabular_model.perspectives.find,
            ObjectType.PERSPECTIVE_HIERARCHY: self._tabular_model.perspective_hierarchies.find,
            ObjectType.PERSPECTIVE_MEASURE: self._tabular_model.perspective_measures.find,
            ObjectType.PERSPECTIVE_TABLE: self._tabular_model.perspective_tables.find,
            ObjectType.QUERY_GROUP: self._tabular_model.query_groups.find,
            ObjectType.RELATIONSHIP: self._tabular_model.relationships.find,
            ObjectType.ROLE: self._tabular_model.roles.find,
            ObjectType.ROLE_MEMBERSHIP: self._tabular_model.role_memberships.find,
            ObjectType.TABLE: self._tabular_model.tables.find,
            ObjectType.TABLE_PERMISSION: self._tabular_model.table_permissions.find,
            ObjectType.VARIATION: self._tabular_model.variations.find,
        }
        if self.object_type not in mapper:
            msg = f"Object Type {self.object_type} does not map to a known SSAS entity type."
            raise TypeError(msg)
        return mapper[self.object_type](self.object_id)

object #

object() -> SsasTable

Returns the object the annotation is describing.

Raises:

Type Description
TypeError

When the Object Type doesn't map to a know SSAS entity type
Source code in pbi_core/ssas/model_tables/annotation/annotation.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def object(self) -> SsasTable:
    """Returns the object the annotation is describing.

    Raises:
        TypeError: When the Object Type doesn't map to a know SSAS entity type

    """
    mapper = {
        ObjectType.ATTRIBUTE_HIERARCHY: self._tabular_model.attribute_hierarchies.find,
        ObjectType.CALCULATION_GROUP: self._tabular_model.calculation_groups.find,
        ObjectType.COLUMN: self._tabular_model.columns.find,
        ObjectType.COLUMN_PERMISSION: self._tabular_model.column_permissions.find,
        ObjectType.CULTURE: self._tabular_model.cultures.find,
        ObjectType.DATASOURCE: self._tabular_model.data_sources.find,
        ObjectType.EXPRESSION: self._tabular_model.expressions.find,
        ObjectType.HIERARCHY: self._tabular_model.hierarchies.find,
        ObjectType.KPI: self._tabular_model.kpis.find,
        ObjectType.LEVEL: self._tabular_model.levels.find,
        ObjectType.LINGUISTIC_METADATA: self._tabular_model.linguistic_metadata.find,
        ObjectType.MEASURE: self._tabular_model.measures.find,
        ObjectType.MODEL: lambda _x: self._tabular_model.model,
        ObjectType.PARTITION: self._tabular_model.partitions.find,
        ObjectType.PERSPECTIVE: self._tabular_model.perspectives.find,
        ObjectType.PERSPECTIVE_HIERARCHY: self._tabular_model.perspective_hierarchies.find,
        ObjectType.PERSPECTIVE_MEASURE: self._tabular_model.perspective_measures.find,
        ObjectType.PERSPECTIVE_TABLE: self._tabular_model.perspective_tables.find,
        ObjectType.QUERY_GROUP: self._tabular_model.query_groups.find,
        ObjectType.RELATIONSHIP: self._tabular_model.relationships.find,
        ObjectType.ROLE: self._tabular_model.roles.find,
        ObjectType.ROLE_MEMBERSHIP: self._tabular_model.role_memberships.find,
        ObjectType.TABLE: self._tabular_model.tables.find,
        ObjectType.TABLE_PERMISSION: self._tabular_model.table_permissions.find,
        ObjectType.VARIATION: self._tabular_model.variations.find,
    }
    if self.object_type not in mapper:
        msg = f"Object Type {self.object_type} does not map to a known SSAS entity type."
        raise TypeError(msg)
    return mapper[self.object_type](self.object_id)

parents_base #

parents_base() -> frozenset[LinkedEntity]

Returns the parent object the annotation is describing.

Source code in pbi_core/ssas/model_tables/annotation/annotation.py 
28
29
30
def parents_base(self) -> frozenset[LinkedEntity]:
    """Returns the parent object the annotation is describing."""
    return LinkedEntity.from_iter({self.object()}, by="object")