cognite-neat 1.0.32__tar.gz → 1.0.33__tar.gz

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 1.0.32
+Version: 1.0.33
 Summary: Knowledge graph transformation
 Author: Nikola Vasiljevic, Anders Albert
 Author-email: Nikola Vasiljevic <nikola.vasiljevic@cognite.com>, Anders Albert <anders.albert@cognite.com>

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/cognite/neat/_data_model/deployer/_differ_container.py

@@ -55,7 +55,7 @@ class ContainerDiffer(ItemDiffer[ContainerRequest]):
                 "constraints",
                 current.constraints,
                 new.constraints,
-                add_severity=SeverityType.SAFE,
+                add_severity=SeverityType.WARNING,
                 remove_severity=SeverityType.WARNING,
                 differ=ConstraintDiffer("constraints"),
             )

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/cognite/neat/_data_model/deployer/data_classes.py

@@ -12,7 +12,6 @@ from pydantic.alias_generators import to_camel
 from cognite.neat._data_model._snapshot import SchemaSnapshot
 from cognite.neat._data_model.models.dms import (
     BaseModelObject,
-    Constraint,
     ContainerConstraintReference,
     ContainerIndexReference,
     ContainerPropertyDefinition,
@@ -20,7 +19,6 @@ from cognite.neat._data_model.models.dms import (
     ContainerRequest,
     DataModelRequest,
     DataModelResource,
-    Index,
     T_DataModelResource,
     T_ResourceId,
     ViewRequest,
@@ -193,7 +191,9 @@ class ContainerDeploymentPlan(ResourceDeploymentPlan[ContainerReference, Contain
     def constraints_to_remove(self) -> dict[ContainerConstraintReference, RemovedField]:
         return self._get_fields_to_remove("constraints.", ContainerConstraintReference)
 
-    def _get_fields_to_remove(self, field_prefix: str, ref_cls: type) -> dict:
+    def _get_fields_to_remove(
+        self, field_prefix: str, ref_cls: type[ContainerIndexReference] | type[ContainerConstraintReference]
+    ) -> dict:
         items: dict = {}
         for resource_change in self.resources:
             for change in resource_change.changes:
@@ -202,7 +202,7 @@ class ContainerDeploymentPlan(ResourceDeploymentPlan[ContainerReference, Contain
                     items[
                         ref_cls(
                             space=resource_change.resource_id.space,
-                            external_id=resource_change.resource_id.external_id,
+                            container_external_id=resource_change.resource_id.external_id,
                             identifier=identifier,
                         )
                     ] = change
@@ -254,7 +254,7 @@ class ResourceDeploymentPlanList(UserList[ResourceDeploymentPlan]):
             updated_resource = resource.model_copy(update={"new_value": resource.current_value})
         elif resource.changes and resource.new_value is not None:
             # Find all field removals and update new_value accordingly.
-            removals = [change for change in resource.changes if isinstance(change, RemovedField)]
+            removals: list[RemovedField] = [change for change in resource.changes if isinstance(change, RemovedField)]
             addition_paths = {change.field_path for change in resource.changes if isinstance(change, AddedField)}
             if removals:
                 if resource.current_value is None:
@@ -271,6 +271,13 @@ class ResourceDeploymentPlanList(UserList[ResourceDeploymentPlan]):
                             for change in resource.changes
                             if not isinstance(change, RemovedField)
                             or (isinstance(change, RemovedField) and change.field_path in addition_paths)
+                            or (
+                                isinstance(change, RemovedField)
+                                and (
+                                    change.field_path.startswith("constraints.")
+                                    or change.field_path.startswith("indexes.")
+                                )
+                            )
                         ],
                     }
                 )
@@ -320,22 +327,14 @@ class ResourceDeploymentPlanList(UserList[ResourceDeploymentPlan]):
         resource: ContainerRequest, removals: list[RemovedField], addition_paths: set[str]
     ) -> DataModelResource:
         container_properties = resource.properties.copy()
-        indexes = (resource.indexes or {}).copy()
-        constraints = (resource.constraints or {}).copy()
         for removal in removals:
             if removal.field_path.startswith("properties."):
                 prop_key = removal.field_path.removeprefix("properties.")
                 container_properties[prop_key] = cast(ContainerPropertyDefinition, removal.current_value)
-            elif removal.field_path.startswith("indexes.") and removal.field_path not in addition_paths:
-                # Index was removed and not re-added, so we need to restore it.
-                index_key = removal.field_path.removeprefix("indexes.")
-                indexes[index_key] = cast(Index, removal.current_value)
-            elif removal.field_path.startswith("constraints.") and removal.field_path not in addition_paths:
-                # Constraint was removed and not re-added, so we need to restore it.
-                constraint_key = removal.field_path.removeprefix("constraints.")
-                constraints[constraint_key] = cast(Constraint, removal.current_value)
+            # Note: indexes and constraints are allowed to be removed in additive mode,
+            # so we don't restore them here unlike properties.
         return resource.model_copy(
-            update={"properties": container_properties, "indexes": indexes or None, "constraints": constraints or None},
+            update={"properties": container_properties},
             deep=True,
         )
 

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/cognite/neat/_data_model/deployer/deployer.py

@@ -185,16 +185,20 @@ class SchemaDeployer(OnSuccessResultProducer):
                 continue
             current_resource = current_resources[ref]
             diffs = differ.diff(current_resource, new_resource)
-            if (
-                isinstance(current_resource, ContainerRequest)
-                and isinstance(new_resource, ContainerRequest)
-                and self.options.modus_operandi == "additive"
-            ):
-                # In additive mode, changes to constraints and indexes require removal and re-adding
-                # In rebuild mode, all changes are forced via deletion and re-adding
+            if isinstance(current_resource, ContainerRequest) and isinstance(new_resource, ContainerRequest):
+                # CDF doesn't support in-place modification of constraints/indexes,
+                # so we transform changes to remove + add operations in both modes
                 diffs = self.remove_readd_modified_indexes_and_constraints(diffs, current_resource, new_resource)
+
+            warnings = self._generate_warnings_for_constraint_and_index_changes(diffs)
             resources.append(
-                ResourceChange(resource_id=ref, new_value=new_resource, current_value=current_resource, changes=diffs)
+                ResourceChange(
+                    resource_id=ref,
+                    new_value=new_resource,
+                    current_value=current_resource,
+                    changes=diffs,
+                    message=" ".join(warnings) if warnings else None,
+                )
             )
 
         return plan_type(endpoint=endpoint, resources=resources)
@@ -222,19 +226,19 @@ class SchemaDeployer(OnSuccessResultProducer):
                     raise RuntimeError("Bug in Neat. Malformed field path for constraint/index change.")
                 # Field type is either "constraints" or "indexes"
                 field_type, identifier, *_ = diff.field_path.split(".", maxsplit=2)
-                # Mark for removal
+                field_path = f"{field_type}.{identifier}"
                 modified_diffs.append(
                     RemovedField(
-                        field_path=f"{field_type}.{identifier}",
+                        field_path=field_path,
                         item_severity=SeverityType.WARNING,
                         current_value=getattr(current_resource, field_type)[identifier],
                     )
                 )
-                # Mark for addition
+                add_severity = SeverityType.WARNING if field_type == "constraints" else SeverityType.SAFE
                 modified_diffs.append(
                     AddedField(
-                        field_path=f"{field_type}.{identifier}",
-                        item_severity=SeverityType.SAFE,
+                        field_path=field_path,
+                        item_severity=add_severity,
                         new_value=getattr(new_resource, field_type)[identifier],
                     )
                 )
@@ -262,6 +266,29 @@ class SchemaDeployer(OnSuccessResultProducer):
             )
         return None
 
+    @classmethod
+    def _generate_warnings_for_constraint_and_index_changes(cls, diffs: list[FieldChange]) -> list[str]:
+        """Generate warning messages for constraint and index changes.
+
+        Args:
+            diffs: The list of field changes.
+
+        Returns:
+            A list of warning messages for field changes involving constraint and index changes.
+        """
+        warnings: list[str] = []
+        if any(isinstance(diff, AddedField) and diff.field_path.startswith("constraints.") for diff in diffs):
+            warnings.append(
+                "Adding constraints could cause ingestion failures if the data being ingested violates the constraint."
+            )
+        if any(
+            isinstance(diff, RemovedField)
+            and (diff.field_path.startswith("constraints.") or diff.field_path.startswith("indexes."))
+            for diff in diffs
+        ):
+            warnings.append("Removing constraints or indexes may affect query performance.")
+        return warnings
+
     def should_proceed_to_deploy(self, plan: Sequence[ResourceDeploymentPlan]) -> bool:
         max_severity_in_plan = SeverityType.max_severity(
             [change.severity for resource_plan in plan for change in resource_plan.resources],

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/cognite/neat/_data_model/models/dms/_http.py

@@ -6,6 +6,8 @@ from cognite.neat._utils.useful_types import ReferenceObject
 from ._container import ContainerRequest
 from ._data_model import DataModelRequest
 from ._references import (
+    ContainerConstraintReference,
+    ContainerIndexReference,
     ContainerReference,
     DataModelReference,
     SpaceReference,
@@ -18,7 +20,14 @@ DataModelResource: TypeAlias = SpaceRequest | DataModelRequest | ViewRequest | C
 
 T_DataModelResource = TypeVar("T_DataModelResource", bound=DataModelResource)
 
-ResourceId: TypeAlias = SpaceReference | DataModelReference | ViewReference | ContainerReference
+ResourceId: TypeAlias = (
+    SpaceReference
+    | DataModelReference
+    | ViewReference
+    | ContainerReference
+    | ContainerIndexReference
+    | ContainerConstraintReference
+)
 
 T_ResourceId = TypeVar("T_ResourceId", bound=ResourceId)
 

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/cognite/neat/_data_model/models/dms/_references.py

@@ -133,9 +133,43 @@ class ViewDirectReference(ReferenceObject):
         return f"{self.source!s}.{self.identifier}"
 
 
-class ContainerIndexReference(ContainerReference):
-    identifier: str
+class ContainerIndexReference(ReferenceObject):
+    """Reference to a container index for deletion API."""
+
+    space: str = Field(
+        description="Id of the space hosting the container.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    container_external_id: str = Field(
+        description="External-id of the container.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+        alias="containerExternalId",
+    )
+    identifier: str = Field(
+        description="Identifier of the index.",
+    )
 
 
-class ContainerConstraintReference(ContainerReference):
-    identifier: str
+class ContainerConstraintReference(ReferenceObject):
+    """Reference to a container constraint for deletion API."""
+
+    space: str = Field(
+        description="Id of the space hosting the container.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    container_external_id: str = Field(
+        description="External-id of the container.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+        alias="containerExternalId",
+    )
+    identifier: str = Field(
+        description="Identifier of the constraint.",
+    )

cognite_neat-1.0.33/cognite/neat/_version.py

@@ -0,0 +1,2 @@
+__version__ = "1.0.33"
+__engine__ = "^2.0.4"

{cognite_neat-1.0.32 → cognite_neat-1.0.33}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite-neat"
-version = "1.0.32"
+version = "1.0.33"
 readme = "README.md"
 description = "Knowledge graph transformation"
 authors = [

cognite_neat-1.0.32/cognite/neat/_version.py

@@ -1,2 +0,0 @@
-__version__ = "1.0.32"
-__engine__ = "^2.0.4"