![](\"https://img.shields.io/badge/Prisma-0F172A?&logo=prisma\"){kind=icon}
\n \n A custom Prisma generator that creates a TypeScript mapping of your model and field names to their database-level names. Stop guessing and start knowing exactly what your database columns are called.\n\nThis repo is a fork of https://github.com/ealexandros/prisma-name-mapper including prisma enums in exported fields\n\n
\n\n## 🤔 What is this?\n\nWhen you use Prisma, you often define your models in camelCase and your database tables and columns in snake_case using @@map and @map. This is great for your code, but what happens when you need to write a raw SQL query, create a migration script, or build a data utility? You end up guessing the database names or constantly checking your schema.prisma file.\n\nPrisma Name Mapper solves this by automatically generating a TypeScript object that maps your Prisma model and field names to their corresponding database names.\n\n## 🚀 Getting Started\n\n#### 1. Installation\n\nInstall the package as a development dependency in your project.\n\n```bash\n# Using npm\n$ npm install -D @dulysse1/prisma-name-mapper\n\n# Using pnpm\n$ pnpm add -D @dulysse1/prisma-name-mapper\n\n# Using bun\n$ bun add -d @dulysse1/prisma-name-mapper\n```\n\n#### 2. Configuration\n\nIn your schema.prisma file, add the dbnames generator:\n\n```prisma\n// schema.prisma\n\ngenerator dbnames {\n provider = \"prisma-name-mapper\"\n // (Required) Define a custom output path.\n output = \"../generated/mapper.ts\"\n}\n\nmodel User {\n // ... your models\n}\n```\n\n#### 3. Generate the Map\n\nRun the prisma generate command. The mapper file will be created at your specified output path.\n\n```bash\n$ bunx prisma generate\n```\n\n## 📦 Example Output\n\nGiven a Prisma schema like this:\n\n```prisma\n// schema.prisma\n\nenum UserType {\n ADMIN\n USER\n\n @@map(\"user_type\")\n}\n\nmodel User {\n id String @id @default(cuid()) @map(\"user_id\")\n fullName String @map(\"full_name\")\n createdAt DateTime @map(\"created_at\")\n\n type UserType // new: support enums!\n\n @@map(\"users\")\n}\n```\n\nThis generator will create the following file, giving you type-safe access to your database names:\n\n```typescript\n// 🔴 AUTO-GENERATED FILE — DO NOT EDIT! 🔴\n//\n// This file is automatically generated by prisma-name-mapper.\n// Do not edit this file directly.\n\nexport const PrismaNameMapper = {\n User: {\n tableName: \"users\",\n schema: null,\n fields: {\n id: \"user_id\",\n fullName: \"full_name\",\n createdAt: \"created_at\",\n type: \"type\", // new: support enums!\n },\n },\n} as const;\n```\n\n## ✨ Why Use It?\n\nThis utility becomes incredibly useful in a variety of scenarios:\n\n- Raw SQL Queries: Write type-safe raw SQL queries without hardcoding table or column names.\n\n```typescript\nimport { PrismaNameMapper } from \"@/prisma/generated/mapper\";\nimport { prisma } from \"@/lib/prisma/client\";\n\nconst userId = \"some-user-id\";\nconst userTable = Prisma.raw(PrismaNameMapper.User.tableName);\nconst userIdCol = Prisma.raw(PrismaNameMapper.User.fields.id);\n\nconst query = Prisma.sql`\n SELECT * FROM ${userTable} WHERE ${userIdCol} = $1\n`;\nconst users = await prisma.$queryRaw(query userId);\n```\n\n- Database Utilities & Seeding: Build scripts for migrations, seeding, or data manipulation with confidence.\n\n```typescript\n// A script to count users\n\nconst userTable = PrismaNameMapper.User.tableName;\nconsole.log(`There are ${count} rows in the ${userTable} table.`);\n```\n\n- Logging & Auditing: Create detailed logs that reference the exact database columns being modified.\n\n- Dynamic APIs: Build dynamic API endpoints or data services that need to know about the underlying database schema.\n\n## 🤝 Contributing\n\nContributions are welcome! If you have a feature request, bug report, or want to improve the code, please open an issue or submit a pull request.\n\n## 📜 License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/ealexandros/prisma-name-mapper/blob/main/LICENSE) file for details.\n\nMade with ❤️ – Built for the Community 🤲\n","readmeFilename":"README.md"}