cognite-neat 0.123.39__py3-none-any.whl → 0.123.41__py3-none-any.whl

cognite/neat/_data_model/importers/__init__.py

@@ -0,0 +1,3 @@
+from ._base import DMSImporter
+
+__all__ = ["DMSImporter"]

cognite/neat/_data_model/importers/_base.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+
+from cognite.neat._data_model.models.dms import RequestSchema
+
+
+class DMSImporter(ABC):
+    """This is the base class for all DMS importers."""
+
+    @abstractmethod
+    def to_data_model(self) -> RequestSchema:
+        """Convert the imported data to a RequestSchema.
+
+        Returns:
+            RequestSchema: The data model as a RequestSchema.
+        """
+        raise NotImplementedError()

cognite/neat/_data_model/models/conceptual/_concept.py

@@ -0,0 +1,67 @@
+from collections import Counter
+
+from pydantic import Field, ValidationInfo, field_validator
+from pyparsing import cast
+
+from cognite.neat._data_model.models.entities import ConceptEntity
+from cognite.neat._data_model.models.entities._constants import PREFIX_PATTERN, SUFFIX_PATTERN, VERSION_PATTERN
+from cognite.neat._utils.text import humanize_collection
+
+from ._base import ResourceMetadata
+from ._property import Property
+
+
+class Concept(ResourceMetadata):
+    space: str = Field(
+        description="Id of the space that the concept belongs to.",
+        min_length=1,
+        max_length=43,
+        pattern=PREFIX_PATTERN,
+        alias="prefix",
+    )
+    external_id: str = Field(
+        description="External-id of the concept.",
+        min_length=1,
+        max_length=255,
+        pattern=SUFFIX_PATTERN,
+        alias="suffix",
+    )
+    version: str | None = Field(
+        default=None,
+        description="Version of the concept.",
+        max_length=43,
+        pattern=VERSION_PATTERN,
+    )
+
+    implements: list[ConceptEntity] | None = Field(
+        default=None,
+        description="References to the concepts from where this concept will inherit properties.",
+    )
+
+    properties: dict[str, Property] | None = Field(default=None, description="Properties associated with the concept.")
+
+    @field_validator("implements", mode="after")
+    def cannot_implement_itself(cls, value: list[ConceptEntity], info: ValidationInfo) -> list[ConceptEntity]:
+        if not value:
+            return value
+
+        this_concept = ConceptEntity(
+            prefix=info.data["space"],
+            suffix=info.data["external_id"],
+            version=cast(str, info.data.get("version")),
+        )
+
+        if this_concept in value:
+            raise ValueError("A concept cannot implement itself.")
+
+        return value
+
+    @field_validator("implements", mode="after")
+    def cannot_have_duplicates(cls, value: list[ConceptEntity], info: ValidationInfo) -> list[ConceptEntity]:
+        counts = Counter(value)
+        duplicates = {concept for concept, count in counts.items() if count > 1}
+
+        if duplicates:
+            raise ValueError(f"Duplicate concepts found: {humanize_collection(duplicates)}")
+
+        return value

cognite/neat/_data_model/models/conceptual/_property.py

@@ -0,0 +1,104 @@
+from typing import Any
+
+from pydantic import Field, ValidationInfo, field_validator, model_validator
+
+from cognite.neat._data_model.models.entities import URI, ConceptEntity, DataType, UnknownEntity
+
+from ._base import ResourceMetadata
+
+
+class Property(ResourceMetadata):
+    value_type: DataType | ConceptEntity | UnknownEntity = Field(
+        union_mode="left_to_right",
+        description="Value type that the property can hold. It takes either subset of XSD type or a class defined.",
+    )
+    min_count: int | None = Field(
+        default=None,
+        ge=0,
+        description="Minimum number of values that the property can hold. "
+        "If no value is provided, the default value is None meaning `0`, "
+        "which means that the property is optional.",
+    )
+    max_count: int | None = Field(
+        default=None,
+        ge=0,
+        description="Maximum number of values that the property can hold. "
+        "If no value is provided, the default value is None meaning `inf`, "
+        "which means that the property can hold any number of values (listable).",
+    )
+    default: Any | None = Field(alias="Default", default=None, description="Default value of the property.")
+    instance_reference: list[URI] | None = Field(
+        default=None,
+        description="The URI(s) in the graph to get the value of the property.",
+    )
+
+    @model_validator(mode="after")
+    def check_min_max_count(self) -> "Property":
+        if self.min_count is not None and self.max_count is not None:
+            if self.min_count > self.max_count:
+                raise ValueError("min_count must be less than or equal to max_count")
+        return self
+
+    @field_validator("default", mode="after")
+    def check_default_value_primitive_type(cls, value: Any, info: ValidationInfo) -> Any:
+        if not value:
+            return value
+
+        value_type = info.data.get("value_type")
+        if not isinstance(value_type, DataType):
+            raise ValueError("Setting default value is only supported for primitive value types.")
+        return value
+
+    @field_validator("default", mode="after")
+    def check_default_value_python_type_exists(cls, value: Any, info: ValidationInfo) -> Any:
+        if not value:
+            return value
+
+        value_type = info.data.get("value_type")
+
+        if isinstance(value_type, DataType) and not hasattr(value_type, "python"):
+            raise ValueError(
+                f"DataType {value_type} does not have a python type defined."
+                " Setting default value for property is not possible."
+            )
+        return value
+
+    @field_validator("default", mode="after")
+    def check_default_value_not_list(cls, value: Any, info: ValidationInfo) -> Any:
+        if not value:
+            return value
+
+        if isinstance(value, list):
+            raise ValueError("Setting list as default value is not supported.")
+        return value
+
+    @field_validator("default", mode="after")
+    def check_default_value_single_valued(cls, value: Any, info: ValidationInfo) -> Any:
+        if not value:
+            return value
+
+        max_count = info.data.get("max_count")
+
+        if max_count is None or max_count > 1:
+            raise ValueError(
+                "Setting default value is only supported for single-valued properties."
+                f" Property has max_count={max_count or 'Inf'}."
+            )
+        return value
+
+    @field_validator("default", mode="after")
+    def check_default_value_type_match(cls, value: Any, info: ValidationInfo) -> Any:
+        if not value:
+            return value
+
+        value_type = info.data.get("value_type")
+
+        if (
+            isinstance(value_type, DataType)
+            and hasattr(value_type, "python")
+            and not isinstance(value, value_type.python)
+        ):
+            raise ValueError(
+                f"Default value type is {type(value)}, which does not match expected value type {value_type.python}."
+            )
+        return value

cognite/neat/_data_model/models/dms/__init__.py

@@ -32,15 +32,53 @@ from cognite.neat._data_model.models.dms._data_types import (
 from cognite.neat._data_model.models.dms._indexes import BtreeIndex, Index, IndexDefinition, InvertedIndex
 from cognite.neat._data_model.models.dms._space import Space, SpaceRequest, SpaceResponse
 
+from ._data_model import DataModelRequest, DataModelResponse
+from ._references import (
+    ContainerDirectReference,
+    ContainerReference,
+    DataModelReference,
+    NodeReference,
+    ViewDirectReference,
+    ViewReference,
+)
+from ._schema import RequestSchema
+from ._view_property import (
+    ConnectionPropertyDefinition,
+    ConstraintOrIndexState,
+    MultiEdgeProperty,
+    MultiReverseDirectRelationPropertyRequest,
+    MultiReverseDirectRelationPropertyResponse,
+    SingleEdgeProperty,
+    SingleReverseDirectRelationPropertyRequest,
+    SingleReverseDirectRelationPropertyResponse,
+    ViewCorePropertyRequest,
+    ViewCorePropertyResponse,
+    ViewPropertyDefinition,
+    ViewRequestProperty,
+    ViewResponseProperty,
+)
+from ._views import (
+    View,
+    ViewRequest,
+    ViewResponse,
+)
+
 __all__ = [
     "BooleanProperty",
     "BtreeIndex",
+    "ConnectionPropertyDefinition",
     "Constraint",
     "ConstraintDefinition",
+    "ConstraintOrIndexState",
     "Container",
+    "ContainerDirectReference",
     "ContainerPropertyDefinition",
+    "ContainerReference",
     "ContainerRequest",
     "ContainerResponse",
+    "DataModelReference",
+    "DataModelRequest",
+    "DataModelResponse",
     "DataType",
     "DateProperty",
     "DirectNodeRelation",
@@ -54,16 +92,39 @@ __all__ = [
     "InvertedIndex",
     "JSONProperty",
     "ListablePropertyTypeDefinition",
+    "MultiEdgeProperty",
+    "MultiReverseDirectRelationPropertyRequest",
+    "MultiReverseDirectRelationPropertyResponse",
+    "NodeReference",
     "PropertyTypeDefinition",
+    "RequestSchema",
     "RequiresConstraintDefinition",
     "Resource",
     "SequenceCDFExternalIdReference",
+    "SequenceCDFExternalIdReference",
+    "SingleEdgeProperty",
+    "SingleReverseDirectRelationPropertyRequest",
+    "SingleReverseDirectRelationPropertyResponse",
     "Space",
     "SpaceRequest",
     "SpaceResponse",
     "TextProperty",
+    "TextProperty",
+    "TimeseriesCDFExternalIdReference",
     "TimeseriesCDFExternalIdReference",
     "TimestampProperty",
+    "TimestampProperty",
+    "UniquenessConstraintDefinition",
     "UniquenessConstraintDefinition",
+    "View",
+    "ViewCorePropertyRequest",
+    "ViewCorePropertyResponse",
+    "ViewDirectReference",
+    "ViewPropertyDefinition",
+    "ViewReference",
+    "ViewRequest",
+    "ViewRequestProperty",
+    "ViewResponse",
+    "ViewResponseProperty",
     "WriteableResource",
 ]

cognite/neat/_data_model/models/dms/_constants.py

@@ -3,6 +3,7 @@ DM_EXTERNAL_ID_PATTERN = r"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$"
 CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN = r"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,253}[a-zA-Z0-9]?$"
 INSTANCE_ID_PATTERN = r"^[^\\x00]{1,256}$"
 ENUM_VALUE_IDENTIFIER_PATTERN = r"^[_A-Za-z][_0-9A-Za-z]{0,127}$"
+DM_VERSION_PATTERN = r"^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$"
 FORBIDDEN_ENUM_VALUES = frozenset({"true", "false", "null"})
 FORBIDDEN_SPACES = frozenset(["space", "cdf", "dms", "pg3", "shared", "system", "node", "edge"])
 FORBIDDEN_CONTAINER_AND_VIEW_EXTERNAL_IDS = frozenset(

cognite/neat/_data_model/models/dms/_container.py

@@ -18,6 +18,7 @@ from ._constants import (
 from ._constraints import Constraint
 from ._data_types import DataType
 from ._indexes import Index
+from ._references import ContainerReference
 
 KEY_PATTERN = re.compile(CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN)
 
@@ -132,6 +133,12 @@ class Container(Resource, ABC):
             )
         return val
 
+    def as_reference(self) -> ContainerReference:
+        return ContainerReference(
+            space=self.space,
+            externalId=self.external_id,
+        )
+
 
 class ContainerRequest(Container): ...
 

cognite/neat/_data_model/models/dms/_data_model.py

@@ -0,0 +1,78 @@
+from abc import ABC
+
+from pydantic import Field
+
+from ._base import Resource, WriteableResource
+from ._constants import (
+    DM_EXTERNAL_ID_PATTERN,
+    DM_VERSION_PATTERN,
+    SPACE_FORMAT_PATTERN,
+)
+from ._references import DataModelReference, ViewReference
+
+
+class DataModel(Resource, ABC):
+    """Cognite Data Model resource.
+
+    Data models group and structure views into reusable collections.
+    A data model contains a set of views where the node types can
+    refer to each other with direct relations and edges.
+    """
+
+    space: str = Field(
+        description="The workspace for the data model, a unique identifier for the space.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="External-id of the data model.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+    )
+    version: str = Field(
+        description="Version of the data model.",
+        max_length=43,
+        pattern=DM_VERSION_PATTERN,
+    )
+    name: str | None = Field(
+        default=None,
+        description="Human readable name for the data model.",
+        max_length=255,
+    )
+    description: str | None = Field(
+        default=None,
+        description="Description of the data model.",
+        max_length=1024,
+    )
+    # The API supports View here, but in Neat we will only use ViewReference
+    views: list[ViewReference] | None = Field(
+        description="List of views included in this data model.",
+        default=None,
+    )
+
+    def as_reference(self) -> DataModelReference:
+        return DataModelReference(
+            space=self.space,
+            externalId=self.external_id,
+            version=self.version,
+        )
+
+
+class DataModelRequest(DataModel): ...
+
+
+class DataModelResponse(DataModel, WriteableResource[DataModelRequest]):
+    created_time: int = Field(
+        description="When the data model was created. The number of milliseconds since 00:00:00 Thursday, "
+        "1 January 1970, Coordinated Universal Time (UTC), minus leap seconds."
+    )
+    last_updated_time: int = Field(
+        description="When the data model was last updated. The number of milliseconds since 00:00:00 Thursday, "
+        "1 January 1970, Coordinated Universal Time (UTC), minus leap seconds."
+    )
+    is_global: bool = Field(description="Is this a global data model.")
+
+    def as_request(self) -> DataModelRequest:
+        return DataModelRequest.model_validate(self.model_dump(by_alias=True))

cognite/neat/_data_model/models/dms/_references.py

@@ -3,10 +3,19 @@ from typing import Literal
 from pydantic import Field
 
 from ._base import BaseModelObject
-from ._constants import DM_EXTERNAL_ID_PATTERN, SPACE_FORMAT_PATTERN
+from ._constants import (
+    CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN,
+    DM_EXTERNAL_ID_PATTERN,
+    DM_VERSION_PATTERN,
+    INSTANCE_ID_PATTERN,
+    SPACE_FORMAT_PATTERN,
+)
 
 
-class ContainerReference(BaseModelObject):
+class ReferenceObject(BaseModelObject, frozen=True): ...
+
+
+class ContainerReference(ReferenceObject):
     type: Literal["container"] = "container"
     space: str = Field(
         description="Id of the space hosting (containing) the container.",
@@ -20,3 +29,83 @@ class ContainerReference(BaseModelObject):
         max_length=255,
         pattern=DM_EXTERNAL_ID_PATTERN,
     )
+
+
+class ViewReference(ReferenceObject):
+    type: Literal["view"] = "view"
+    space: str = Field(
+        description="Id of the space that the view belongs to.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="External-id of the view.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+    )
+    version: str = Field(
+        description="Version of the view.",
+        max_length=43,
+        pattern=DM_VERSION_PATTERN,
+    )
+
+
+class DataModelReference(ReferenceObject):
+    space: str = Field(
+        description="Id of the space that the data model belongs to.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="External-id of the data model.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+    )
+    version: str = Field(
+        description="Version of the data model.",
+        max_length=43,
+        pattern=DM_VERSION_PATTERN,
+    )
+
+
+class NodeReference(ReferenceObject):
+    space: str = Field(
+        description="Id of the space hosting (containing) the node.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="External-id of the node.",
+        min_length=1,
+        max_length=255,
+        pattern=INSTANCE_ID_PATTERN,
+    )
+
+
+class ContainerDirectReference(ReferenceObject):
+    source: ContainerReference = Field(
+        description="Reference to the container from where this relation is inherited.",
+    )
+    identifier: str = Field(
+        description="Identifier of the relation in the source container.",
+        min_length=1,
+        max_length=255,
+        pattern=CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN,
+    )
+
+
+class ViewDirectReference(ReferenceObject):
+    source: ViewReference = Field(
+        description="Reference to the view from where this relation is inherited.",
+    )
+    identifier: str = Field(
+        description="Identifier of the relation in the source view.",
+        min_length=1,
+        max_length=255,
+        pattern=CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN,
+    )

cognite/neat/_data_model/models/dms/_schema.py

@@ -0,0 +1,18 @@
+from pydantic import Field
+
+from ._base import Resource
+from ._container import ContainerRequest
+from ._data_model import DataModelRequest
+from ._references import NodeReference
+from ._space import SpaceRequest
+from ._views import ViewRequest
+
+
+class RequestSchema(Resource):
+    """Represents a schema for creating or updating a data model in DMS."""
+
+    data_model: DataModelRequest
+    views: list[ViewRequest] = Field(default_factory=list)
+    containers: list[ContainerRequest] = Field(default_factory=list)
+    spaces: list[SpaceRequest] = Field(default_factory=list)
+    node_types: list[NodeReference] = Field(default_factory=list)

cognite/neat/_data_model/models/dms/_view_property.py

@@ -0,0 +1,198 @@
+from abc import ABC
+from typing import Annotated, Literal
+
+from pydantic import Field, Json
+
+from ._base import BaseModelObject, Resource, WriteableResource
+from ._constants import CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN
+from ._data_types import DataType
+from ._references import ContainerDirectReference, ContainerReference, NodeReference, ViewDirectReference, ViewReference
+
+
+class ViewPropertyDefinition(Resource, ABC):
+    connection_type: str
+
+
+class ViewCoreProperty(ViewPropertyDefinition, ABC):
+    # Core properties do not have connection type in the API, but we add it here such that
+    # we can use it as a discriminator in unions. The exclude=True ensures that it is not
+    # sent to the API.
+    connection_type: Literal["primary_property"] = Field(default="primary_property", exclude=True)
+    name: str | None = Field(
+        default=None,
+        description="Readable property name.",
+        max_length=255,
+    )
+    description: str | None = Field(
+        default=None,
+        description="Description of the content and suggested use for this property..",
+        max_length=1024,
+    )
+    container: ContainerReference = Field(
+        description="Reference to the container where this property is defined.",
+    )
+    container_property_identifier: str = Field(
+        description="Identifier of the property in the container.",
+        min_length=1,
+        max_length=255,
+        pattern=CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN,
+    )
+    source: ViewReference | None = Field(
+        default=None,
+        description="Indicates on what type a referenced direct relation is expected to be. "
+        "Only applicable for direct relation properties.",
+    )
+
+
+class ViewCorePropertyRequest(ViewCoreProperty): ...
+
+
+class ConstraintOrIndexState(BaseModelObject):
+    nullability: Literal["current", "pending", "failed"] | None = Field(
+        description="""For properties that have isNullable set to false, this field describes the validity of the
+not-null constraint. It is not specified for nullable properties.
+
+Possible values are:
+
+"failed": The property contains null values, violating the constraint. This can occur if a property with
+          existing nulls was made non-nullable. New null values will still be rejected.
+"current": The constraint is satisfied; all values in the property are not null.
+"pending": The constraint validity has not yet been computed.
+        """
+    )
+
+
+class ViewCorePropertyResponse(ViewCoreProperty, WriteableResource[ViewCorePropertyRequest]):
+    immutable: bool | None = Field(
+        default=None,
+        description="Should updates to this property be rejected after the initial population?",
+    )
+    nullable: bool | None = Field(
+        default=None,
+        description="Does this property need to be set to a value, or not?",
+    )
+    auto_increment: bool | None = Field(
+        default=None,
+        description="Increment the property based on its highest current value (max value).",
+    )
+    default_value: str | int | bool | dict[str, Json] | None = Field(
+        default=None,
+        description="Default value to use when you do not specify a value for the property.",
+    )
+    constraint_state: ConstraintOrIndexState = Field(
+        description="Describes the validity of constraints defined on this property"
+    )
+    type: DataType = Field(description="The type of data you can store in this property.")
+
+    def as_request(self) -> ViewCorePropertyRequest:
+        return ViewCorePropertyRequest.model_validate(self.model_dump(by_alias=True))
+
+
+class ConnectionPropertyDefinition(ViewPropertyDefinition, ABC):
+    name: str | None = Field(
+        default=None,
+        description="Readable property name.",
+        max_length=255,
+    )
+    description: str | None = Field(
+        default=None,
+        description="Description of the content and suggested use for this property..",
+        max_length=1024,
+    )
+
+
+class EdgeProperty(ConnectionPropertyDefinition, ABC):
+    source: ViewReference = Field(
+        description="The target node(s) of this connection can be read through the view specified in 'source'."
+    )
+    type: NodeReference = Field(
+        description="Reference to the node pointed to by the direct relation. The reference consists of a "
+        "space and an external-id."
+    )
+    edge_source: ViewReference | None = Field(
+        None, description="The edge(s) of this connection can be read through the view specified in 'edgeSource'."
+    )
+    direction: Literal["outwards", "inwards"] = Field(
+        "outwards", description="The direction of the edge(s) of this connection."
+    )
+
+
+class SingleEdgeProperty(EdgeProperty):
+    connection_type: Literal["single_edge_connection"] = "single_edge_connection"
+
+
+class MultiEdgeProperty(EdgeProperty):
+    connection_type: Literal["multi_edge_connection"] = "multi_edge_connection"
+
+
+class ReverseDirectRelationProperty(ConnectionPropertyDefinition, ABC):
+    source: ViewReference = Field(
+        description="The node(s) containing the direct relation property can be read "
+        "through the view specified in 'source'."
+    )
+
+
+class SingleReverseDirectRelationPropertyRequest(ReverseDirectRelationProperty):
+    connection_type: Literal["single_reverse_direct_relation"] = "single_reverse_direct_relation"
+    # The API support through as either ViewDirectReference or ContainerDirectReference. However, in Neat
+    # we only use ContainerDirectReference. This is for simplicity and it improves performance as the server
+    # does not have to resolve the view to a container first.
+    through: ContainerDirectReference = Field(
+        description="The view of the node containing the direct relation property."
+    )
+
+
+class SingleReverseDirectRelationPropertyResponse(
+    ReverseDirectRelationProperty, WriteableResource[SingleReverseDirectRelationPropertyRequest]
+):
+    connection_type: Literal["single_reverse_direct_relation"] = "single_reverse_direct_relation"
+    through: ContainerDirectReference | ViewDirectReference = Field(
+        description="The view of the node containing the direct relation property."
+    )
+
+    def as_request(self) -> SingleReverseDirectRelationPropertyRequest:
+        if isinstance(self.through, ViewDirectReference):
+            raise TypeError("Cannot convert to request when 'through' is a ViewDirectReference.")
+        return SingleReverseDirectRelationPropertyRequest.model_validate(self.model_dump(by_alias=True))
+
+
+class MultiReverseDirectRelationPropertyRequest(ReverseDirectRelationProperty):
+    connection_type: Literal["multi_reverse_direct_relation"] = "multi_reverse_direct_relation"
+    # The API support through as either ViewDirectReference or ContainerDirectReference. However, in Neat
+    # we only use ContainerDirectReference. This is for simplicity and it improves performance as the server
+    # does not have to resolve the view to a container first.
+    through: ContainerDirectReference = Field(
+        description="The view of the node containing the direct relation property."
+    )
+
+
+class MultiReverseDirectRelationPropertyResponse(
+    ReverseDirectRelationProperty, WriteableResource[MultiReverseDirectRelationPropertyRequest]
+):
+    connection_type: Literal["multi_reverse_direct_relation"] = "multi_reverse_direct_relation"
+    through: ContainerDirectReference | ViewDirectReference = Field(
+        description="The view of the node containing the direct relation property."
+    )
+
+    def as_request(self) -> MultiReverseDirectRelationPropertyRequest:
+        if isinstance(self.through, ViewDirectReference):
+            raise TypeError("Cannot convert to request when 'through' is a ViewDirectReference.")
+        return MultiReverseDirectRelationPropertyRequest.model_validate(self.model_dump(by_alias=True))
+
+
+ViewRequestProperty = Annotated[
+    SingleEdgeProperty
+    | MultiEdgeProperty
+    | SingleReverseDirectRelationPropertyRequest
+    | MultiReverseDirectRelationPropertyRequest
+    | ViewCorePropertyRequest,
+    Field(discriminator="connection_type"),
+]
+ViewResponseProperty = Annotated[
+    SingleEdgeProperty
+    | MultiEdgeProperty
+    | SingleReverseDirectRelationPropertyResponse
+    | MultiReverseDirectRelationPropertyResponse
+    | ViewCorePropertyResponse,
+    Field(discriminator="connection_type"),
+]

cognite/neat/_data_model/models/dms/_views.py

@@ -0,0 +1,164 @@
+import re
+from abc import ABC
+from typing import Literal, TypeVar
+
+from pydantic import Field, Json, field_validator, model_validator
+
+from cognite.neat._utils.text import humanize_collection
+
+from ._base import Resource, WriteableResource
+from ._constants import (
+    CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN,
+    DM_EXTERNAL_ID_PATTERN,
+    DM_VERSION_PATTERN,
+    FORBIDDEN_CONTAINER_AND_VIEW_EXTERNAL_IDS,
+    FORBIDDEN_CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER,
+    SPACE_FORMAT_PATTERN,
+)
+from ._references import ContainerReference, ViewReference
+from ._view_property import (
+    ViewRequestProperty,
+    ViewResponseProperty,
+)
+
+KEY_PATTERN = re.compile(CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN)
+
+
+class View(Resource, ABC):
+    space: str = Field(
+        description="Id of the space that the view belongs to.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="External-id of the view.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+    )
+    version: str = Field(
+        description="Version of the view.",
+        max_length=43,
+        pattern=DM_VERSION_PATTERN,
+    )
+    name: str | None = Field(
+        default=None,
+        description="name for the view.",
+        max_length=255,
+    )
+    description: str | None = Field(
+        default=None,
+        description="Description of the view.",
+        max_length=1024,
+    )
+    filter: dict[str, Json] | None = Field(
+        default=None,
+        description="A filter Domain Specific Language (DSL) used to create advanced filter queries.",
+    )
+    implements: list[ViewReference] | None = Field(
+        default=None,
+        description="References to the views from where this view will inherit properties.",
+    )
+
+    def as_reference(self) -> ViewReference:
+        return ViewReference(space=self.space, externalId=self.external_id, version=self.version)
+
+    @model_validator(mode="before")
+    def set_connection_type_on_primary_properties(cls, data: dict) -> dict:
+        if "properties" not in data:
+            return data
+        properties = data["properties"]
+        if not isinstance(properties, dict):
+            return data
+        # We assume all properties without connectionType are core properties.
+        # The reason we set connectionType it easy for pydantic to discriminate the union.
+        # This also leads to better error messages, as if there is a union and pydantic do not know which
+        # type to pick it will give errors from all type in the union.
+        for prop in properties.values():
+            if isinstance(prop, dict) and "connectionType" not in prop:
+                prop["connectionType"] = "primary_property"
+        return data
+
+    @field_validator("external_id", mode="after")
+    def check_forbidden_external_id_value(cls, val: str) -> str:
+        """Check the external_id not present in forbidden set"""
+        if val in FORBIDDEN_CONTAINER_AND_VIEW_EXTERNAL_IDS:
+            raise ValueError(
+                f"'{val}' is a reserved view External ID. Reserved External IDs are: "
+                f"{humanize_collection(FORBIDDEN_CONTAINER_AND_VIEW_EXTERNAL_IDS)}"
+            )
+        return val
+
+
+class ViewRequest(View):
+    properties: dict[str, ViewRequestProperty] = Field(
+        description="View with included properties and expected edges, indexed by a unique space-local identifier."
+    )
+
+    @field_validator("properties", mode="after")
+    def validate_properties_identifier(cls, val: dict[str, ViewRequestProperty]) -> dict[str, ViewRequestProperty]:
+        """Validate properties Identifier"""
+        return _validate_properties_keys(val)
+
+
+class ViewResponse(View, WriteableResource[ViewRequest]):
+    properties: dict[str, ViewResponseProperty] = Field(
+        description="List of properties and connections included in this view."
+    )
+
+    created_time: int = Field(
+        description="When the view was created. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, "
+        "Coordinated Universal Time (UTC), minus leap seconds."
+    )
+    last_updated_time: int = Field(
+        description="When the view was last updated. The number of milliseconds since 00:00:00 Thursday, "
+        "1 January 1970, Coordinated Universal Time (UTC), minus leap seconds."
+    )
+    writable: bool = Field(
+        description="oes the view support write operations, i.e. is it writable? "
+        "You can write to a view if the view maps all non-nullable properties."
+    )
+    queryable: bool = Field(
+        description="Does the view support queries, i.e. is it queryable? You can query a view if "
+        "it either has a filter or at least one property mapped to a container."
+    )
+    used_for: Literal["node", "edge", "all"] = Field(description="Should this operation apply to nodes, edges or both.")
+    is_global: bool = Field(description="Is this a global view.")
+    mapped_containers: list[ContainerReference] = Field(
+        description="List of containers with properties mapped by this view."
+    )
+
+    @field_validator("properties", mode="after")
+    def validate_properties_identifier(cls, val: dict[str, ViewResponseProperty]) -> dict[str, ViewResponseProperty]:
+        """Validate properties Identifier"""
+        return _validate_properties_keys(val)
+
+    def as_request(self) -> ViewRequest:
+        dumped = self.model_dump(by_alias=True, exclude={"properties"})
+        dumped["properties"] = {
+            key: value.as_request().model_dump(by_alias=True)
+            if isinstance(value, WriteableResource)
+            else value.model_dump(by_alias=True)
+            for key, value in self.properties.items()
+        }
+        return ViewRequest.model_validate(dumped)
+
+
+T_Property = TypeVar("T_Property")
+
+
+def _validate_properties_keys(properties: dict[str, T_Property]) -> dict[str, T_Property]:
+    """Validate keys of a properties dictionary."""
+    errors: list[str] = []
+    for key in properties:
+        if not KEY_PATTERN.match(key):
+            errors.append(f"Property '{key}' does not match the required pattern: {KEY_PATTERN.pattern}")
+        if key in FORBIDDEN_CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER:
+            errors.append(
+                f"'{key}' is a reserved property identifier. Reserved identifiers are: "
+                f"{humanize_collection(FORBIDDEN_CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER)}"
+            )
+    if errors:
+        raise ValueError("; ".join(errors))
+    return properties

cognite/neat/_data_model/models/entities/_base.py

@@ -4,6 +4,9 @@ from typing import Any
 from pydantic import BaseModel, Field, field_validator, model_serializer
 
 from ._constants import (
+    PREFIX_PATTERN,
+    SUFFIX_PATTERN,
+    VERSION_PATTERN,
     Undefined,
     Unknown,
     _UndefinedType,
@@ -15,10 +18,8 @@ from ._constants import (
 class Entity(BaseModel, extra="ignore", populate_by_name=True):
     """Entity is a concept, class, property, datatype in semantics sense."""
 
-    prefix: str | _UndefinedType = Field(
-        default=Undefined, pattern=r"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", min_length=1, max_length=43
-    )
-    suffix: str = Field(min_length=1, max_length=255, pattern=r"^[a-zA-Z0-9._~?@!$&'*+,;=%-]+$")
+    prefix: str | _UndefinedType = Field(default=Undefined, pattern=PREFIX_PATTERN, min_length=1, max_length=43)
+    suffix: str = Field(min_length=1, max_length=255, pattern=SUFFIX_PATTERN)
 
     @model_serializer(when_used="unless-none", return_type=str)
     def as_str(self) -> str:
@@ -88,7 +89,7 @@ class Entity(BaseModel, extra="ignore", populate_by_name=True):
 
 
 class ConceptEntity(Entity):
-    version: str | None = None
+    version: str | None = Field(default=None, pattern=VERSION_PATTERN, max_length=43)
 
 
 class UnknownEntity(ConceptEntity):

cognite/neat/_data_model/models/entities/_constants.py

@@ -15,3 +15,8 @@ class _UnknownType(BaseModel):
 # This is a trick to make Undefined and Unknown singletons
 Undefined = _UndefinedType()
 Unknown = _UnknownType()
+
+
+PREFIX_PATTERN = r"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$"
+SUFFIX_PATTERN = r"^[a-zA-Z0-9._~?@!$&'*+,;=%-]+$"
+VERSION_PATTERN = r"^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$"

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.123.39"
+__version__ = "0.123.41"
 __engine__ = "^2.0.4"

cognite/neat/v0/core/_instances/queries/_select.py

@@ -450,3 +450,45 @@ class SelectQueries(BaseQuery):
                 yield instance_id, str(space.toPython())
             else:
                 yield instance_id, str(space)
+
+    def _get_graph_diff(
+        self, source_graph: URIRef, target_graph: URIRef
+    ) -> Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]]:
+        query = f"""
+        SELECT ?s ?p ?o
+        WHERE {{
+        GRAPH <{source_graph}> {{ ?s ?p ?o }}
+        FILTER NOT EXISTS {{
+            GRAPH <{target_graph}> {{ ?s ?p ?o }}
+        }}
+        }}
+        """
+        return cast(Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]], self.dataset.query(query))
+
+    def get_triples_to_delete(
+        self, old_graph: URIRef, new_graph: URIRef
+    ) -> Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]]:
+        """Find triples that exist in old graph but not in new graph.
+
+        Args:
+            old_graph: URI of the old named graph
+            new_graph: URI of the new named graph
+
+        Returns:
+            List of triples (subject, predicate, object) to delete
+        """
+        return self._get_graph_diff(old_graph, new_graph)
+
+    def get_triples_to_add(
+        self, old_graph: URIRef, new_graph: URIRef
+    ) -> Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]]:
+        """Find triples that exist in new graph but not in old graph.
+
+        Args:
+            old_graph: URI of the old named graph
+            new_graph: URI of the new named graph
+
+        Returns:
+            List of triples (subject, predicate, object) to add
+        """
+        return self._get_graph_diff(new_graph, old_graph)

{cognite_neat-0.123.39.dist-info → cognite_neat-0.123.41.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.39
+Version: 0.123.41
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/

{cognite_neat-0.123.39.dist-info → cognite_neat-0.123.41.dist-info}/RECORD

@@ -1,26 +1,34 @@
 cognite/neat/__init__.py,sha256=Lo4DbjDOwnhCYUoAgPp5RG1fDdF7OlnomalTe7n1ydw,211
 cognite/neat/_issues.py,sha256=uv0fkkWwTKqNmTmHqyoBB3L6yMCh42EZpEkLGmIJYOY,812
-cognite/neat/_version.py,sha256=ZTWVKANnFlW6QqktADqgWQm0NPnrSBLdQ7Z_g2suOds,47
+cognite/neat/_version.py,sha256=ufRXfLAZOiccgiTU2G1cLrNuGEalUnTHSuR_tpkSN2w,47
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/_constants.py,sha256=NGGvWHlQqhkkSBP_AqoofGYjNph3SiZX6QPINlMsy04,107
 cognite/neat/_data_model/_identifiers.py,sha256=a0LcQ_h0NffxSKTCrzCDpYkrlaUTk-D_rfaQUh-BhWc,1921
+cognite/neat/_data_model/importers/__init__.py,sha256=GUp7WkjX6R02lQRHD-2ygkwNGPSWbFjrFettnCdrrAQ,58
+cognite/neat/_data_model/importers/_base.py,sha256=NRB0FcEBj4GaethU68nRffBfTedBBA866A3zfJNfmiQ,433
 cognite/neat/_data_model/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/models/conceptual/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/models/conceptual/_base.py,sha256=SFkoBJDM51pqew_isHFJoB20OgfofpwVRnTrg-rKkNY,710
+cognite/neat/_data_model/models/conceptual/_concept.py,sha256=0Pk4W2TJ_Y0Z7oPHpzely1kPXrAkmkyqw6a0n3il6LY,2248
 cognite/neat/_data_model/models/conceptual/_properties.py,sha256=CpF37vJYBTLT4DH4ZOu2U-JyWtkb_27V8fw52qiaE_k,4007
-cognite/neat/_data_model/models/dms/__init__.py,sha256=0YalizBE9PK_5JtzG1_fhrRhrRuqCUsWwWBkY4X4PHo,1876
+cognite/neat/_data_model/models/conceptual/_property.py,sha256=CpF37vJYBTLT4DH4ZOu2U-JyWtkb_27V8fw52qiaE_k,4007
+cognite/neat/_data_model/models/dms/__init__.py,sha256=I_yw2GoEjUdLk8VOiLSlU4BWgE3u_GgCHJayeEa1w1w,3583
 cognite/neat/_data_model/models/dms/_base.py,sha256=R8SP3Zi9daTBqewYKGjuNEkrWc-j91f-6t34CN-9YJ0,719
-cognite/neat/_data_model/models/dms/_constants.py,sha256=tLyle1N_ekNBhANleG7GvZB85P4uGaoWl2mqeR-vfmY,1272
+cognite/neat/_data_model/models/dms/_constants.py,sha256=wBkLjAPwufPc2naxOfPA1XC0CM2RbDbo6Dpiv9dPrew,1344
 cognite/neat/_data_model/models/dms/_constraints.py,sha256=7Nv-EoNl6lSHUQh6r15Ei0LzR3gWV006K3RlAi1Ic68,956
-cognite/neat/_data_model/models/dms/_container.py,sha256=ovyAwsh2ACt0j9-j6ooDOdUl0uKlGdkjYA2UUvJfHrw,5756
+cognite/neat/_data_model/models/dms/_container.py,sha256=SgrMCRo04A1gqayJsCia6oMhYT7q3NaeMBZMOQNI-lA,5967
+cognite/neat/_data_model/models/dms/_data_model.py,sha256=GNa05JEj_eSRGoKB8vkR85-Qv-IhPlDR3gXZNQMfe6g,2537
 cognite/neat/_data_model/models/dms/_data_types.py,sha256=XSGQWVzYFRYAzKsDln20nC2kqiHQC6JAvDeTzCBPT-0,5202
 cognite/neat/_data_model/models/dms/_indexes.py,sha256=MsiHbGCH50QaF1mw_pIY-AZ5dY37vS3fQECOd2rBXWo,780
-cognite/neat/_data_model/models/dms/_references.py,sha256=yrmMo2JNfupG3tppdjLOaEhUAsRSIjZlBOI6hCol1z4,613
+cognite/neat/_data_model/models/dms/_references.py,sha256=LJ7xlXATf7AP_Uj-8LlxatQk5GG1Tu4CHGK63cJqUU4,3078
+cognite/neat/_data_model/models/dms/_schema.py,sha256=2JFLcm52smzPdtZ69Lf02UbYAD8I_hpRbI7ZAzdxJJs,641
 cognite/neat/_data_model/models/dms/_space.py,sha256=-1LkRmQaAdIj2EYDcVv5Mcejl5uswgAEVv7DztpIUk4,1680
+cognite/neat/_data_model/models/dms/_view_property.py,sha256=wiRxb5qtzGnBooBUzN7xtwMBZiZ9aRFcN5ML4lCTXdQ,8331
+cognite/neat/_data_model/models/dms/_views.py,sha256=afUZisM-6r0_IeSwn8ZVFAqWfodHBWrMcFnk_a-ewSI,6579
 cognite/neat/_data_model/models/entities/__init__.py,sha256=qdtIpyy2hjfdMwEHya-efOCvWassaalQla15RnqK00E,798
-cognite/neat/_data_model/models/entities/_base.py,sha256=PREgBqc6DM9pLn3VXFWxPBMVK0sexl6s3twSHn9wsf0,3874
-cognite/neat/_data_model/models/entities/_constants.py,sha256=P56zgsL2xqfegWOxEAyPm9qrZcxrjb1ZXqMG7cDmQxc,333
+cognite/neat/_data_model/models/entities/_base.py,sha256=PaNrD29iwxuqTpRWbmESMTxRhhKXmRyDF_cLZEC69dg,3927
+cognite/neat/_data_model/models/entities/_constants.py,sha256=EK9Bus8UgFgxK5cVFMTAqWSl6aWkDe7d59hpUmlHlBs,517
 cognite/neat/_data_model/models/entities/_data_types.py,sha256=DfdEWGek7gODro-_0SiiInhPGwul4zn-ASACQfn8HUY,2838
 cognite/neat/_data_model/models/entities/_identifiers.py,sha256=uBiK4ot3V0b_LGXuJ7bfha6AEcFI3p2letr1z2iSvig,1923
 cognite/neat/_data_model/models/entities/_parser.py,sha256=ZLGw0cFV-B7JuaAUJ65Jbjf6o-vidz9_BZvilS6lAZw,6455
@@ -147,7 +155,7 @@ cognite/neat/v0/core/_instances/loaders/_rdf_to_instance_space.py,sha256=T1nNzhY
 cognite/neat/v0/core/_instances/queries/__init__.py,sha256=W477LMyB4l6HIRbQhJoFgA_MUBwVCh2GBvtFeZu0AUA,53
 cognite/neat/v0/core/_instances/queries/_base.py,sha256=APevHeeWQDEoOQ0MlBtVlPf9hbZukVkI5fOvt5oPJCE,543
 cognite/neat/v0/core/_instances/queries/_queries.py,sha256=4BidSQXhdZYZ6_kyG7jMJ2iG0UtSrbQxfmwPM7V167A,466
-cognite/neat/v0/core/_instances/queries/_select.py,sha256=nVhXGA8oSVNfhXo7p2poM40ATbQ2wXa6TFeJiJl7Nto,19105
+cognite/neat/v0/core/_instances/queries/_select.py,sha256=NYEEGafbb02poVb3vJ9Ov0XQq9f8YRxpfqq1WFc-36Q,20539
 cognite/neat/v0/core/_instances/queries/_update.py,sha256=WJmh0hGoKT4pbbWeED6udFAXiv_qFPd3v9tnZLORcNk,1293
 cognite/neat/v0/core/_instances/transformers/__init__.py,sha256=YzC1Z8BuT77NwagWX4Z-F9R9BARLSS7zM4bCdxBbqKg,1761
 cognite/neat/v0/core/_instances/transformers/_base.py,sha256=a8TVhgYGdt7Mj5-omT6gxOHeGvYnMd9vJCty6p7ctx4,4707
@@ -223,7 +231,7 @@ cognite/neat/v0/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4
 cognite/neat/v0/session/engine/_import.py,sha256=1QxA2_EK613lXYAHKQbZyw2yjo5P9XuiX4Z6_6-WMNQ,169
 cognite/neat/v0/session/engine/_interface.py,sha256=3W-cYr493c_mW3P5O6MKN1xEQg3cA7NHR_ev3zdF9Vk,533
 cognite/neat/v0/session/engine/_load.py,sha256=u0x7vuQCRoNcPt25KJBJRn8sJabonYK4vtSZpiTdP4k,5201
-cognite_neat-0.123.39.dist-info/METADATA,sha256=eQFt9KEee3JdoiaHaQE7FRyA0Jd53JEIOzsVZ53Gxbk,9148
-cognite_neat-0.123.39.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.123.39.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.123.39.dist-info/RECORD,,
+cognite_neat-0.123.41.dist-info/METADATA,sha256=x1il3bStkdRMLwIwGMK5UABcb2tkCyc3Zr63dkY27Vw,9148
+cognite_neat-0.123.41.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.123.41.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.123.41.dist-info/RECORD,,