Class ProjectModel

app/api/agentops/opsboard/models.py:611–729

Model that maps to the projects table

class ProjectModel(BaseProjectModel, BaseModel):
    """Model that maps to the projects table"""

    __tablename__ = "projects"
    __table_args__ = {"schema": "public"}

    is_sparse = False
    id = model.Column(model.UUID, primary_key=True, default=uuid.uuid4)
    org_id = model.Column(model.UUID, model.ForeignKey("public.orgs.id"), nullable=False)
    api_key = model.Column(model.UUID, unique=True, default=uuid.uuid4)
    name = model.Column(model.String, nullable=False)
    environment = model.Column(model.Enum(Environment), default=Environment.development, nullable=False)

    org = orm.relationship("OrgModel", back_populates="projects")

    @property
    @require_loaded('org')
    def is_freeplan(self) -> bool:
        """Check if the organization is on a pro plan."""
        return self.org.is_freeplan

    def get_project(self, orm: orm.Session) -> Optional["ProjectModel"]:
        """For ProjectModel, return self since it's already the full model."""
        return self

    @classmethod
    def get_by_id(cls, orm: orm.Session, project_id: str | UUID) -> Optional['ProjectModel']:
        """Get a project by ID with org and necessary relationships preloaded."""
        # This loads org.users, org.invites, and org.projects relationships which are
        # needed when returning a `ProjectResponse` in these view functions:
        # - get_project
        # - create_project
        # - update_project
        # - regenerate_api_key
        # TODO: Consider optimizing with count queries instead of loading full relationships
        # when we only need counts for org.current_member_count and org.current_project_count.
        return (
            orm.query(cls)
            .filter(cls.id == normalize_uuid(project_id))
            .options(
                joinedload(cls.org).joinedload(OrgModel.users),
                joinedload(cls.org).joinedload(OrgModel.invites),
                joinedload(cls.org).joinedload(OrgModel.projects),
            )
            .first()
        )

    @classmethod
    def get_by_api_key(cls, orm: orm.Session, api_key: str | UUID) -> Optional['ProjectModel']:
        """Get a project by API key with org and necessary relationships preloaded."""
        return (
            orm.query(cls)
            .filter(cls.api_key == normalize_uuid(api_key))
            .options(
                joinedload(cls.org).joinedload(OrgModel.users),
                joinedload(cls.org).joinedload(OrgModel.invites),
                joinedload(cls.org).joinedload(OrgModel.projects),
            )