Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

2.6 KB
Raw Blame
from django.conf import settings
from django.db import models
from django.utils import timezone

from posthog.models.activity_logging.model_activity import ModelActivityMixin
from posthog.models.scoping.root_mixin import TeamScopedRootMixin
from posthog.models.utils import DeletedMetaFields, UUIDTModel


class DataWarehouseExpression(ModelActivityMixin, TeamScopedRootMixin, UUIDTModel, DeletedMetaFields):
    """A saved HogQL expression exposed as a virtual field on a table.

    The expression is injected into the team's HogQL database on every build, so the
    field is available in all SQL queries. It can never shadow an existing field:
    injection skips names already present on the table.
    """

    # db_constraint=False on the hot-table FKs (team, created_by) so CreateModel takes no lock
    # on posthog_team / posthog_user; app-level enforcement is enough here.
    team = models.ForeignKey("posthog.Team", on_delete=models.CASCADE, db_constraint=False, related_name="+")
    created_at = models.DateTimeField(auto_now_add=True, blank=True)
    created_by = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.SET_NULL,
        null=True,
        blank=True,
        db_constraint=False,
        related_name="+",
    )
    table_name = models.CharField(max_length=400)
    field_name = models.CharField(max_length=400)
    expression = models.TextField()
    # ExternalDataSource id when the expression is scoped to one connection's direct-query
    # database; null scopes it to the default warehouse database.
    connection_id = models.UUIDField(null=True, blank=True)

    class Meta:
        # Backstop for the serializer's check-then-act duplicate validation. Two constraints
        # because Postgres treats NULLs as distinct, so a null connection_id needs its own guard.
        # `deleted` is nullable and null counts as active, hence the isnull clause.
        constraints = [
            models.UniqueConstraint(
                fields=["team", "table_name", "field_name", "connection_id"],
                condition=models.Q(deleted=False) | models.Q(deleted__isnull=True),
                name="uniq_dw_expression_active_connection",
            ),
            models.UniqueConstraint(
                fields=["team", "table_name", "field_name"],
                condition=(models.Q(deleted=False) | models.Q(deleted__isnull=True))
                & models.Q(connection_id__isnull=True),
                name="uniq_dw_expression_active_default",
            ),
        ]

    def soft_delete(self) -> None:
        self.deleted = True
        self.deleted_at = timezone.now()
        self.save()