ethyca-fides 2.64.1b2__py2.py3-none-any.whl → 2.64.2b0__py2.py3-none-any.whl

fides/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-06-19T19:04:31-0600",
+ "date": "2025-06-26T17:32:16+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "087f9ed16cb93d2b16e48ffe667e7350f4984229",
- "version": "2.64.1b2"
+ "full-revisionid": "a393007f54ae4f6f6660c0eadb35ad167a869be7",
+ "version": "2.64.2b0"
 }
 '''  # END VERSION_JSON
 

fides/api/db/database.py

@@ -15,8 +15,8 @@ from sqlalchemy_utils.types.encrypted.encrypted_type import InvalidCiphertextErr
 
 from fides.api.db.base import Base  # type: ignore[attr-defined]
 from fides.api.db.seed import load_default_resources
+from fides.api.db.session import get_db_engine
 from fides.api.util.errors import get_full_exception_name
-from fides.core.utils import get_db_engine
 
 DatabaseHealth = Literal["healthy", "unhealthy", "needs migration"]
 
@@ -41,6 +41,14 @@ def upgrade_db(alembic_config: Config, revision: str = "head") -> None:
     command.upgrade(alembic_config, revision)
 
 
+def init_db(database_url: str) -> None:
+    """
+    Runs the migrations and creates all of the database objects.
+    """
+    alembic_config = get_alembic_config(database_url)
+    upgrade_db(alembic_config)
+
+
 def downgrade_db(alembic_config: Config, revision: str = "head") -> None:
     """Downgrade the database to the specified migration revision."""
     log.info(f"Running database downgrade to revision {revision}")
@@ -78,7 +86,7 @@ def reset_db(database_url: str) -> None:
     Drops all tables/metadata from the database.
     """
     log.info("Resetting database...")
-    engine = get_db_engine(database_url)
+    engine = get_db_engine(database_uri=database_url)
     with engine.connect() as connection:
         log.info("Dropping tables...")
         Base.metadata.drop_all(connection)
@@ -136,3 +144,20 @@ def configure_db(database_url: str, revision: Optional[str] = "head") -> None:
         log.error("Unable to configure database: {}: {}", error_type, error)
         log.opt(exception=True).error(error)
         raise
+
+
+def check_missing_migrations(database_url: str) -> None:
+    """
+    Tries to autogenerate migrations, returns True if a migration
+    was generated.
+    """
+
+    engine = get_db_engine(database_uri=database_url)
+    connection = engine.connect()
+
+    migration_context = migration.MigrationContext.configure(connection)
+    result = command.autogen.compare_metadata(migration_context, Base.metadata)  # type: ignore[attr-defined]
+
+    if result:
+        raise SystemExit("Migrations needs to be generated!")
+    print("No migrations need to be generated.")

fides/api/models/attachment.py

@@ -5,9 +5,9 @@ from typing import IO, TYPE_CHECKING, Any, Tuple
 
 from fideslang.validation import AnyHttpUrlString
 from loguru import logger as log
-from sqlalchemy import Column
+from sqlalchemy import Column, DateTime
 from sqlalchemy import Enum as EnumColumn
-from sqlalchemy import ForeignKey, String, UniqueConstraint, orm
+from sqlalchemy import ForeignKey, Index, String, UniqueConstraint, func, orm
 from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import Session, relationship
 
@@ -64,8 +64,14 @@ class AttachmentReference(Base):
         """Overriding base class method to set the table name."""
         return "attachment_reference"
 
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+
     attachment_id = Column(
-        String, ForeignKey("attachment.id", ondelete="CASCADE"), nullable=False
+        String,
+        ForeignKey("attachment.id", name="attachment_reference_attachment_id_fkey"),
+        nullable=False,
     )
     reference_id = Column(String, nullable=False)
     reference_type = Column(EnumColumn(AttachmentReferenceType), nullable=False)
@@ -74,6 +80,8 @@ class AttachmentReference(Base):
         UniqueConstraint(
             "attachment_id", "reference_id", name="_attachment_reference_uc"
         ),
+        Index("ix_attachment_reference_reference_id", "reference_id"),
+        Index("ix_attachment_reference_reference_type", "reference_type"),
     )
 
     # Relationships
@@ -92,6 +100,10 @@ class Attachment(Base):
     Stores information about an Attachment.
     """
 
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+
     user_id = Column(
         String, ForeignKey("fidesuser.id", ondelete="SET NULL"), nullable=True
     )

fides/api/models/comment.py

@@ -1,13 +1,13 @@
 from enum import Enum as EnumType
 from typing import TYPE_CHECKING, Any
 
-from sqlalchemy import Column
+from sqlalchemy import Column, DateTime
 from sqlalchemy import Enum as EnumColumn
-from sqlalchemy import ForeignKey, String, UniqueConstraint, orm
+from sqlalchemy import ForeignKey, Index, String, func, orm
 from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import Session, relationship
 
-from fides.api.db.base_class import Base
+from fides.api.db.base_class import Base, FidesBase
 from fides.api.models.attachment import Attachment, AttachmentReferenceType
 
 if TYPE_CHECKING:
@@ -48,12 +48,24 @@ class CommentReference(Base):
         """Overriding base class method to set the table name."""
         return "comment_reference"
 
-    comment_id = Column(String, ForeignKey("comment.id"), nullable=False)
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+
+    comment_id = Column(
+        String,
+        ForeignKey(
+            "comment.id", name="comment_reference_comment_id_fkey", ondelete="CASCADE"
+        ),
+        nullable=False,
+    )
     reference_id = Column(String, nullable=False)
     reference_type = Column(EnumColumn(CommentReferenceType), nullable=False)
 
     __table_args__ = (
-        UniqueConstraint("comment_id", "reference_id", name="comment_reference_uc"),
+        Index("ix_comment_reference_reference_id", "reference_id"),
+        Index("ix_comment_reference_reference_type", "reference_type"),
     )
 
     comment = relationship(
@@ -75,6 +87,11 @@ class Comment(Base):
     Stores information about a Comment.
     """
 
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+
     user_id = Column(
         String, ForeignKey("fidesuser.id", ondelete="SET NULL"), nullable=True
     )

fides/api/models/db_cache.py

@@ -32,7 +32,7 @@ class DBCache(Base):
     cache_value = Column(BYTEA, nullable=False)
 
     __table_args__ = (
-        Index("ix_dbcache_namespace_cache_key", "namespace", "cache_key"),
+        Index("ix_dbcache_namespace_cache_key", "namespace", "cache_key", unique=True),
     )
 
     @classmethod

fides/api/models/detection_discovery/core.py

@@ -159,6 +159,8 @@ class MonitorConfig(Base):
         "MonitorExecution",
         cascade="all, delete-orphan",
         backref="monitor_config",
+        primaryjoin="MonitorExecution.monitor_config_key == foreign(MonitorConfig.key)",
+        single_parent=True,
     )
 
     shared_config_id = Column(
@@ -342,16 +344,16 @@ class StagedResourceAncestor(Base):
     Its entries should be deleted when the staged resource is deleted, via cascade.
     """
 
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+
     ancestor_urn = Column(
         String,
         ForeignKey("stagedresource.urn", ondelete="CASCADE"),
-        primary_key=True,
         nullable=False,
     )
     descendant_urn = Column(
         String,
         ForeignKey("stagedresource.urn", ondelete="CASCADE"),
-        primary_key=True,
         nullable=False,
     )
 
@@ -372,6 +374,7 @@ class StagedResourceAncestor(Base):
         UniqueConstraint(
             "ancestor_urn", "descendant_urn", name="uq_staged_resource_ancestor"
         ),
+        Index("ix_staged_resource_ancestor_pkey", "id", unique=True),
         Index("ix_staged_resource_ancestor_ancestor", "ancestor_urn"),
         Index("ix_staged_resource_ancestor_descendant", "descendant_urn"),
     )
@@ -470,12 +473,7 @@ class StagedResource(Base):
         server_default="{}",
         default=dict,
     )
-    user_assigned_system_id = Column(
-        String,
-        ForeignKey(System.id_field_path),
-        nullable=True,
-        index=True,
-    )
+    user_assigned_system_id = Column(String, nullable=True, index=True)
 
     # pointers to child and parent URNs
     children = Column(
@@ -527,7 +525,7 @@ class StagedResource(Base):
 
     data_uses = Column(
         ARRAY(String),
-        nullable=False,
+        nullable=True,
         server_default="{}",
         default=dict,
     )
@@ -588,12 +586,14 @@ class MonitorExecution(Base):
     configuration details used in connecting to the external data store.
     """
 
-    monitor_config_key = Column(
-        String,
-        ForeignKey(MonitorConfig.key),
-        nullable=False,
-        index=True,
-    )
+    # redefined here because there's a minor, unintended discrepancy between
+    # this `id` field and that of the `Base` class, which explicitly sets `index=True`.
+    # TODO: we likely should _not_ be setting `index=True` on the `id`
+    # attribute of the `Base` class, as `primary_key=True` already specifies a
+    # primary key constraint, which will implicitly create an index for the field.
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+
+    monitor_config_key = Column(String, nullable=False, index=True)
     status = Column(String, nullable=True)
     started = Column(
         DateTime(timezone=True),

fides/api/models/fides_user_respondent_email_verification.py

@@ -3,12 +3,13 @@ from __future__ import annotations
 from datetime import datetime, timedelta, timezone
 from typing import TYPE_CHECKING, Any, Optional
 
-from sqlalchemy import Column, DateTime, ForeignKey, String
+from sqlalchemy import Column, DateTime, ForeignKey, Index, String
 from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import Session, relationship
+from sqlalchemy.sql import func
 
 from fides.api.cryptography.cryptographic_util import generate_secure_random_string
-from fides.api.db.base_class import Base
+from fides.api.db.base_class import Base, FidesBase
 from fides.api.util.identity_verification import IdentityVerificationMixin
 from fides.config import get_config
 
@@ -40,6 +41,22 @@ class FidesUserRespondentEmailVerification(Base, IdentityVerificationMixin):
     def __tablename__(self) -> str:
         return "fides_user_respondent_email_verification"
 
+    # redefined here because there's a minor, unintended discrepancy between
+    # this `id` field and that of the `Base` class, which explicitly sets `index=True`.
+    # TODO: we likely should _not_ be setting `index=True` on the `id`
+    # attribute of the `Base` class, as `primary_key=True` already specifies a
+    # primary key constraint, which will implicitly create an index for the field.
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+    updated_at = Column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now(),
+        nullable=False,
+    )
+
     user_id = Column(
         String,
         ForeignKey("fidesuser.id", ondelete="CASCADE"),
@@ -59,6 +76,14 @@ class FidesUserRespondentEmailVerification(Base, IdentityVerificationMixin):
         foreign_keys=[user_id],
     )
 
+    __table_args__ = (
+        Index(
+            "ix_fides_user_respondent_email_verification_id",
+            "id",
+            unique=True,
+        ),
+    )
+
     @classmethod
     def create(
         cls, db: Session, *, data: dict[str, Any], check_name: bool = False

fides/api/models/manual_tasks/manual_task.py

@@ -1,10 +1,11 @@
 from typing import TYPE_CHECKING, Any
 
-from sqlalchemy import Column, ForeignKey, String
+from sqlalchemy import Column, DateTime, ForeignKey, Index, String, UniqueConstraint
 from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import Session, relationship
+from sqlalchemy.sql import func
 
-from fides.api.db.base_class import Base
+from fides.api.db.base_class import Base, FidesBase
 from fides.api.db.util import EnumColumn
 from fides.api.models.manual_tasks.manual_task_log import ManualTaskLog
 from fides.api.schemas.manual_tasks.manual_task_schemas import (
@@ -40,6 +41,22 @@ class ManualTask(Base):
         """Overriding base class method to set the table name."""
         return "manual_task"
 
+    # redefined here because there's a minor, unintended discrepancy between
+    # this `id` field and that of the `Base` class, which explicitly sets `index=True`.
+    # TODO: we likely should _not_ be setting `index=True` on the `id`
+    # attribute of the `Base` class, as `primary_key=True` already specifies a
+    # primary key constraint, which will implicitly create an index for the field.
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+    updated_at = Column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now(),
+        nullable=False,
+    )
+
     # Database columns
     task_type = Column(
         EnumColumn(ManualTaskType),
@@ -53,6 +70,16 @@ class ManualTask(Base):
         default=ManualTaskParentEntityType.connection_config,
     )
 
+    __table_args__ = (
+        UniqueConstraint(
+            "parent_entity_id",
+            "parent_entity_type",
+            name="uq_manual_task_parent_entity",
+        ),
+        Index("ix_manual_task_parent_entity", "parent_entity_type", "parent_entity_id"),
+        Index("ix_manual_task_task_type", "task_type"),
+    )
+
     # Relationships
     references = relationship(
         "ManualTaskReference",
@@ -125,6 +152,22 @@ class ManualTaskReference(Base):
         """Overriding base class method to set the table name."""
         return "manual_task_reference"
 
+    # redefined here because there's a minor, unintended discrepancy between
+    # this `id` field and that of the `Base` class, which explicitly sets `index=True`.
+    # TODO: we likely should _not_ be setting `index=True` on the `id`
+    # attribute of the `Base` class, as `primary_key=True` already specifies a
+    # primary key constraint, which will implicitly create an index for the field.
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+    updated_at = Column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now(),
+        nullable=False,
+    )
+
     # Database columns
     task_id = Column(
         String, ForeignKey("manual_task.id", ondelete="CASCADE"), nullable=False
@@ -132,5 +175,10 @@ class ManualTaskReference(Base):
     reference_id = Column(String, nullable=False)
     reference_type = Column(EnumColumn(ManualTaskReferenceType), nullable=False)
 
+    __table_args__ = (
+        Index("ix_manual_task_reference_reference", "reference_id", "reference_type"),
+        Index("ix_manual_task_reference_task_id", "task_id"),
+    )
+
     # Relationships
     task = relationship("ManualTask", back_populates="references", viewonly=True)

fides/api/models/manual_tasks/manual_task_config.py

@@ -1,11 +1,21 @@
 from typing import TYPE_CHECKING, Any, Optional, cast
 
-from sqlalchemy import Boolean, Column, ForeignKey, Integer, String
+from sqlalchemy import (
+    Boolean,
+    Column,
+    DateTime,
+    ForeignKey,
+    Index,
+    Integer,
+    String,
+    UniqueConstraint,
+)
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import Session, relationship
+from sqlalchemy.sql import func
 
-from fides.api.db.base_class import Base
+from fides.api.db.base_class import Base, FidesBase
 from fides.api.db.util import EnumColumn
 from fides.api.models.manual_tasks.manual_task_log import ManualTaskLog
 from fides.api.schemas.manual_tasks.manual_task_config import (
@@ -37,7 +47,31 @@ class ManualTaskConfig(Base):
     def __tablename__(cls) -> str:
         return "manual_task_config"
 
-    task_id = Column(String, ForeignKey("manual_task.id"), nullable=False)
+    # redefined here because there's a minor, unintended discrepancy between
+    # this `id` field and that of the `Base` class, which explicitly sets `index=True`.
+    # TODO: we likely should _not_ be setting `index=True` on the `id`
+    # attribute of the `Base` class, as `primary_key=True` already specifies a
+    # primary key constraint, which will implicitly create an index for the field.
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+    updated_at = Column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now(),
+        nullable=False,
+    )
+
+    task_id = Column(
+        String,
+        ForeignKey(
+            "manual_task.id",
+            name="manual_task_config_task_id_fkey",
+            ondelete="CASCADE",
+        ),
+        nullable=False,
+    )
     config_type = Column(EnumColumn(ManualTaskConfigurationType), nullable=False)
     version = Column(Integer, nullable=False, default=1)
     is_current = Column(Boolean, nullable=False, default=True)
@@ -47,6 +81,11 @@ class ManualTaskConfig(Base):
         default=ManualTaskExecutionTiming.pre_execution,
     )
 
+    __table_args__ = (
+        Index("ix_manual_task_config_config_type", "config_type"),
+        Index("ix_manual_task_config_task_id", "task_id"),
+    )
+
     # Relationships
     task = relationship("ManualTask", back_populates="configs", viewonly=True)
     instances = relationship(
@@ -109,8 +148,40 @@ class ManualTaskConfigField(Base):
     def __tablename__(cls) -> str:
         return "manual_task_config_field"
 
-    task_id = Column(String, ForeignKey("manual_task.id"), nullable=False)
-    config_id = Column(String, ForeignKey("manual_task_config.id"), nullable=False)
+    # redefined here because there's a minor, unintended discrepancy between
+    # this `id` field and that of the `Base` class, which explicitly sets `index=True`.
+    # TODO: we likely should _not_ be setting `index=True` on the `id`
+    # attribute of the `Base` class, as `primary_key=True` already specifies a
+    # primary key constraint, which will implicitly create an index for the field.
+    id = Column(String(255), primary_key=True, default=FidesBase.generate_uuid)
+    created_at = Column(
+        DateTime(timezone=True), server_default=func.now(), nullable=False
+    )
+    updated_at = Column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now(),
+        nullable=False,
+    )
+
+    task_id = Column(
+        String,
+        ForeignKey(
+            "manual_task.id",
+            name="manual_task_config_field_task_id_fkey",
+            ondelete="CASCADE",
+        ),
+        nullable=False,
+    )
+    config_id = Column(
+        String,
+        ForeignKey(
+            "manual_task_config.id",
+            name="manual_task_config_field_config_id_fkey",
+            ondelete="CASCADE",
+        ),
+        nullable=False,
+    )
     field_key = Column(String, nullable=False)
     field_type = Column(
         EnumColumn(ManualTaskFieldType), nullable=False
@@ -119,6 +190,13 @@ class ManualTaskConfigField(Base):
         dict[str, Any], Column(JSONB, nullable=False, default={})
     )
 
+    __table_args__ = (
+        UniqueConstraint("config_id", "field_key", name="unique_field_key_per_config"),
+        Index("ix_manual_task_config_field_config_id", "config_id"),
+        Index("ix_manual_task_config_field_field_key", "field_key"),
+        Index("ix_manual_task_config_field_task_id", "task_id"),
+    )
+
     # Relationships
     config = relationship(
         "ManualTaskConfig", back_populates="field_definitions", viewonly=True