feat: add migrations.seed to the config docs DC-4716 #7062
Conversation
WalkthroughThe updates consist of two main changes: documentation corrections and formatting improvements for externally managed tables, and the extension of the PrismaConfig type's migrations property to include new seed and initShadowDb string fields, with accompanying documentation and usage examples. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Prisma CLI
participant Database
User->>Prisma CLI: Run migration command (with seed configured)
Prisma CLI->>Database: Apply migrations
Prisma CLI->>Prisma CLI: Check migrations.seed config
alt seed configured
Prisma CLI->>Prisma CLI: Run seed script (e.g., tsx ./prisma/seed.ts)
end
Prisma CLI->>User: Report migration and seeding status
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested reviewers
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
| Latest commit: |
06dadf7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8fff28f9.docs-51g.pages.dev |
| Branch Preview URL: | https://patch-6-13.docs-51g.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
content/200-orm/100-prisma-schema/20-data-model/65-externally-managed-tables.mdx (1)
74-75: Consistency tweakConsider lower-casing “PostgreSQL” and “SQL Server” in the same bullet to match sentence-case style used elsewhere in the doc.
content/200-orm/500-reference/325-prisma-config-reference.mdx (3)
79-81: MarkseedandinitShadowDboptional in the type snippetThe surrounding narrative says these properties are optional (“Required | No”), but the snippet declares them as mandatory. Align them to avoid confusion.
- path: string; - seed: string; - initShadowDb: string; + path: string; + seed?: string; + initShadowDb?: string;
232-239: Section heading/duplication inconsistencyYou now document
migrations.pathhere, but the parent section header remains### \migrate`(singular). Renaming that header to### `migrations`(plural) will line up with the property name and avoid two similarly-named sections (migratevsmigrations.*`).
240-258: Minor “db seed” command referenceYou mention “using the npx prisma db seed command”. For consistency with other CLI references in the docs, wrap the full command in back-ticks:
npx prisma db seed
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/200-orm/100-prisma-schema/20-data-model/65-externally-managed-tables.mdx(3 hunks)content/200-orm/500-reference/325-prisma-config-reference.mdx(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: runner / linkspector
- GitHub Check: Check internal links
- GitHub Check: Lost Pixel
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
content/200-orm/100-prisma-schema/20-data-model/65-externally-managed-tables.mdx (1)
33-34: Wording fix looks goodThe new phrasing is clearer and grammatically correct.
* feat: add migrations.seed to the config docs DC-4716 * fix: clear typos DC-4680
2 participants
Summary by CodeRabbit