Skip to content

UserModeling

cognite.neat._issues.warnings.user_modeling #

These are user modeling warnings. These warnings will not cause the resulting model to be invalid, but will likely lead to suboptimal performance, unnecessary complexity, or other issues.

DirectRelationMissingSourceWarning dataclass #

Bases: UserModelingWarning

The view {view_id}.{prop_name} is a direct relation without a source. Direct relations in views should point to a single other view, if not, you end up with a more complex model than necessary.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
26
27
28
29
30
31
32
33
34
35
@dataclass(unsafe_hash=True)
class DirectRelationMissingSourceWarning(UserModelingWarning):
    """The view {view_id}.{prop_name} is a direct relation without a source.
    Direct relations in views should point to a single other view, if not, you end up
    with a more complex model than necessary."""

    fix = "Create the source view"

    view_id: ViewId
    prop_name: str

ParentInDifferentSpaceWarning dataclass #

Bases: UserModelingWarning

The view {view_id} has multiple parents in different spaces. Neat recommends maximum one implementation of a view from another space.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
38
39
40
41
42
43
44
45
@dataclass(unsafe_hash=True)
class ParentInDifferentSpaceWarning(UserModelingWarning):
    """The view {view_id} has multiple parents in different spaces.
    Neat recommends maximum one implementation of a view from another space."""

    fix = "Ensure all parents of the view are in the same space"

    view_id: ViewId

EmptyContainerWarning dataclass #

Bases: UserModelingWarning

Container {container_id} is empty and will be skipped. The container does not have any properties.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
48
49
50
51
52
53
54
55
@dataclass(unsafe_hash=True)
class EmptyContainerWarning(UserModelingWarning):
    """Container {container_id} is empty and will be skipped.
    The container does not have any properties."""

    fix = "Add properties to the container or remove the container"

    container_id: ContainerId

HasDataFilterOnNoPropertiesViewWarning dataclass #

Bases: UserModelingWarning

Cannot set hasData filter on view {view_id}. The view does not have properties in any containers. Use a node type filter instead.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
58
59
60
61
62
63
64
65
66
@dataclass(unsafe_hash=True)
class HasDataFilterOnNoPropertiesViewWarning(UserModelingWarning):
    """Cannot set hasData filter on view {view_id}.
    The view does not have properties in any containers.
    Use a node type filter instead."""

    fix = "Use a node type filter instead"

    view_id: ViewId

NodeTypeFilterOnParentViewWarning dataclass #

Bases: UserModelingWarning

Setting a node type filter on parent view {view_id}. This is not recommended as parent views are typically used for multiple types of nodes.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
69
70
71
72
73
74
75
76
@dataclass(unsafe_hash=True)
class NodeTypeFilterOnParentViewWarning(UserModelingWarning):
    """Setting a node type filter on parent view {view_id}.
    This is not recommended as parent views are typically used for multiple types of nodes."""

    fix = "Use a HasData filter instead"

    view_id: ViewId

HasDataFilterOnViewWithReferencesWarning dataclass #

Bases: UserModelingWarning

Setting a hasData filter on view {view_id} which references other views {references}. This is not recommended as it will lead to no nodes being returned when querying the solution view. Use a NodeType filter instead.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
79
80
81
82
83
84
85
86
87
88
@dataclass(unsafe_hash=True)
class HasDataFilterOnViewWithReferencesWarning(UserModelingWarning):
    """Setting a hasData filter on view {view_id} which references other views {references}.
    This is not recommended as it will lead to no nodes being returned when querying the solution view.
    Use a NodeType filter instead."""

    fix = "Use a NodeType filter instead"

    view_id: ViewId
    references: frozenset[ViewId]

ViewPropertyLimitWarning dataclass #

Bases: UserModelingWarning

The number of properties in the {view_id} view is {count} which is more than the API limit {limit} properties. This can lead to performance issues. Reduce the number of properties in the view.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
@dataclass(unsafe_hash=True)
class ViewPropertyLimitWarning(UserModelingWarning):
    """The number of properties in the {view_id} view is {count} which
    is more than the API limit {limit} properties.
    This can lead to performance issues.
    Reduce the number of properties in the view."""

    fix = "Reduce the number of properties in the view"

    view_id: ViewId
    count: int
    limit: int = DMS_CONTAINER_PROPERTY_SIZE_LIMIT

NotNeatSupportedFilterWarning dataclass #

Bases: UserModelingWarning

The view {view_id} uses a non-standard filter. This will not be validated by Neat, and is thus not recommended. If you can use a HasData or NoteType filter.

Source code in cognite/neat/_issues/warnings/user_modeling.py 
105
106
107
108
109
110
111
112
113
@dataclass(unsafe_hash=True)
class NotNeatSupportedFilterWarning(UserModelingWarning):
    """The view {view_id} uses a non-standard filter.
    This will not be validated by Neat, and is thus not recommended.
    If you can use a HasData or NoteType filter."""

    fix = "Use a HasData or NoteType filter instead"

    view_id: ViewId