Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
How the Prisma schema is organized and the conventions it follows
backend/prisma/schema.prisma. It is organized into logical sections with comment dividers:
// ─── Client & Organization ───────────────────────────────
model Client { ... }
model Region { ... }
model Department { ... }
model Store { ... }
// ─── Users & Auth ────────────────────────────────────────
model User { ... }
model UserRole { ... }
model Session { ... }
// ─── Catalog ─────────────────────────────────────────────
model UniformCategory { ... }
model Product { ... }
// ... etc
| Convention | Example |
|---|---|
| Primary keys | id String @id @default(cuid()) |
| Timestamps | createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt |
| Soft delete | active Boolean @default(true) flag on domain records |
| Client scoping | clientId String + client Client @relation(fields: [clientId], references: [id]) |
| Optional relations | departmentId String? + department Department? @relation(...) |
| Enums | PascalCase names (OrderStatus, EmploymentType) |
| JSON fields | values Json for criteria values, before/after Json? for audit |
| Unique constraints | @@unique([clientId, code]) for client-scoped codes |
| Indexes | @@index([clientId]) for scoping filters |
| Enum | Values |
|---|---|
Role | SUPER_ADMIN, MUZE_ADMIN, HR, STORE_MANAGER, EMPLOYEE |
AccountStatus | PENDING_ACTIVATION, ACTIVE, DISABLED |
EmploymentType | PERMANENT, CASUAL, CONTRACT |
AllocationPhase / PeriodType | INITIAL, REPLACEMENT (allocation items also allow BOTH) |
PeriodStatus | PENDING, ACTIVE, RESERVED, CONSUMED, EXHAUSTED, CANCELLED |
PaymentType | COMPANY_PAID, EMPLOYEE_PAID |
OrderStatus | PENDING_APPROVAL, SUBMITTED, APPROVED, REJECTED, CANCELLED, PROCESSING, MANUFACTURING, EMBROIDERY, QUALITY_CHECK, PACKED, DISPATCHED, DELIVERED |
NotificationChannel | IN_APP, EMAIL, WHATSAPP (reserved) |
ProductType | GOLFER, SHIRT, TROUSERS and other garment types |
generator client {
provider = "prisma-client-js"
output = "../node_modules/.prisma/client"
}
@prisma/client.
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
directUrl = env("DIRECT_URL")
}
| Field | Purpose |
|---|---|
url | Pooled connection (via PgBouncer) used for application queries |
directUrl | Direct connection used for migrations |
schema.prisma is the single source of truth for the database structure. Migration workflow is covered in Transactions and migrations.Was this page helpful?