Support for splitting Prisma schema into multiple files #2377

albertoperdomo · 2020-05-05T18:40:27Z

Problem

Prisma currently only supports one single Prisma Schema file. Developers want more flexibility for managing their Prisma Schema files.

Motivations:

breaking up large schema files to make them more manageable
flexible integration with certain architectures, i.e. each module has its own self-contained logic including its schema

Solution

Support importing additional schema files, i.e. import "user.schema", import models/*.prisma or import modules/**/*.prisma.

Alternatives

Not researched at this time.

Additional context

#92

The text was updated successfully, but these errors were encountered:

ChristophDietrich · 2020-05-08T16:01:31Z

Like prisma one ... there was a feature like this implemented.

paniavula · 2020-05-14T16:47:01Z

Appreciate prioritisation of this. It is really painful to write all the schema in one file.

beeplin · 2020-05-14T17:09:23Z

badly need this feature. currently I have to cat a.prisma b.prisma > schema.prisma. it works but is so clumsy.

JontyCoertzen · 2020-06-02T15:40:01Z

Any update on this?

SteveSonoa · 2020-11-13T03:20:32Z

Any movement on this? Really looking for this solution.

yhaiovyi · 2020-11-14T18:34:08Z

It's a dealbreaker for me...

cudba · 2020-11-30T06:56:23Z

until this is part of the prisma cli, we extracted a small script which we use internally into this tiny cli prisma-merge. its nothing fancy but works for us currently. feel free to use it or copy the source and tailor it to your needs.

hgezim · 2021-01-02T08:02:01Z

Ideally, I'd like my models to live near their/in modules in Nest.

slinden2 · 2021-01-02T15:49:47Z

Would be a nice feature. A single file is not maintainable.

kevinvdburgt · 2021-01-26T09:05:39Z

Please, don't be hostile.

I would love to see this feature as well coming to Prisma 2. There is a workaround (we used in some projects) which might help:

cat *.part.prisma > schema.prisma
yarn prisma generate

yazer79 · 2021-02-06T09:11:55Z

I think this is a "basic" feature for any project. Many months passed now, and there is no update on this.
I can't believe Iit is so hard to make a modular schema file and that would actually take almost a year and no progress on this basic matter

paulosalvatore · 2021-02-07T06:54:33Z

I agree that this is really needed, but npx prisma-merge provides a great workaround.

Thank you guys and looking forward on this implementation :)

ncirkel · 2021-02-07T12:26:13Z

Good workarounds exist and have been proposed, but one basic modular use case that is holding me back is this one:

Module A:

type Story {
  id: ID!
}

Module B:

type Product {
  id: ID!
  relatedStories: [Story!]!
}

extend type Story {
  relatedProducts: [Product!]!
}

This wasn't possible in Prisma 1 either, but it would be amazing if the Prisma devs could make that happen.

ChristophDietrich · 2021-02-07T13:41:05Z

Good workarounds exist and have been proposed, but one basic modular use case that is holding me back is this one:

Module A:
type Story {

  id: ID!

}
Module B:
type Product {

  id: ID!

  relatedStories: [Story!]!

}



extend type Story {

  relatedProducts: [Product!]!

}
This wasn't possible in Prisma 1 either, but it would be amazing if the Prisma devs could make that happen.

This would be very very awesome 👏 👏👏

* Implement multi-file schema handling in PSL This commit implements multi-file schema handling in the Prisma Schema Language. At a high level, instead of accepting a single string, `psl::validate_multi_file()` is an alternative to `psl::validate()` that accepts something morally equivalent to: ```json { "./prisma/schema/a.prisma": "datasource db { ... }", "./prisma/schema/nested/b.prisma": "model Test { ... }" } ``` There are tests for PSL validation with multiple schema files, but most of the rest of engines still consumes the single file version of `psl::validate()`. The implementation and the return type are shared between `psl::validate_multi_file()` and `psl::validate()`, so the change is completely transparent, other than the expectation of passing in a list of (file_name, file_contents) instead of a single string. The `psl::validate()` entry point should behave exactly the same as `psl::multi_schema()` with a single file named `schema.prisma`. In particular, it has the exact same return type. Implementation ============== This is achieved by extending `Span` to contain, in addition to a start and end offset, a `FileId`. The `FileId` is a unique identifier for a file and its parsed `SchemaAst` inside `ParserDatabase`. The identifier types for AST items in `ParserDatabase` are also extended to contain the `FileId`, so that they can be uniquely referred to in the context of the (multi-file) schema. After the analysis phase (the `parser_database` crate), consumers of the analyzed schema become multi-file aware completely transparently, no change is necessary in the other engines. The only changes that will be required at scattered points across the codebase are the `psl::validate()` call sites that will need to receive a `Vec<Box<Path>, SourceFile>` instead of a single `SourceFile`. This PR does _not_ deal with that, but it makes where these call sites are obvious by what entry points they use: `psl::validate()`, `psl::parse_schema()` and the various `*_assert_single()` methods on `ParserDatabase`. The PR contains tests confirming that schema analysis, validation and displaying diagnostics across multiple files works as expected. Status of this PR ================= This is going to be directly mergeable after review, and it will not affect the current schema handling behaviour when dealing with a single schema file. Next steps ========== - Replace all calls to `psl::validate()` with calls to `psl::validate_multi_file()`. - The `*_assert_single()` calls should be progressively replaced with their multi-file counterparts across engines. - The language server should start sending multiple files to prisma-schema-wasm in all calls. This is not in the spirit of the language server spec, but that is the most immediate solution. We'll have to make `range_to_span()` in `prisma-fmt` multi-schema aware by taking a FileId param. Links ===== Relevant issue: prisma/prisma#2377 Also see the [internal design doc](https://www.notion.so/prismaio/Multi-file-Schema-24d68fe8664048ad86252fe446caac24?d=68ef128f25974e619671a9855f65f44d#2889a038e68c4fe1ac9afe3cd34978bd). * chore(prisma-fmt): fix typo * chore(prisma-fmt): add comment * chore(prisma-fmt): fix compilation after #4137 --------- Co-authored-by: Alberto Schiabel <[email protected]> Co-authored-by: jkomyno <[email protected]>

* Implement multi-file schema handling in PSL This commit implements multi-file schema handling in the Prisma Schema Language. At a high level, instead of accepting a single string, `psl::validate_multi_file()` is an alternative to `psl::validate()` that accepts something morally equivalent to: ```json { "./prisma/schema/a.prisma": "datasource db { ... }", "./prisma/schema/nested/b.prisma": "model Test { ... }" } ``` There are tests for PSL validation with multiple schema files, but most of the rest of engines still consumes the single file version of `psl::validate()`. The implementation and the return type are shared between `psl::validate_multi_file()` and `psl::validate()`, so the change is completely transparent, other than the expectation of passing in a list of (file_name, file_contents) instead of a single string. The `psl::validate()` entry point should behave exactly the same as `psl::multi_schema()` with a single file named `schema.prisma`. In particular, it has the exact same return type. Implementation ============== This is achieved by extending `Span` to contain, in addition to a start and end offset, a `FileId`. The `FileId` is a unique identifier for a file and its parsed `SchemaAst` inside `ParserDatabase`. The identifier types for AST items in `ParserDatabase` are also extended to contain the `FileId`, so that they can be uniquely referred to in the context of the (multi-file) schema. After the analysis phase (the `parser_database` crate), consumers of the analyzed schema become multi-file aware completely transparently, no change is necessary in the other engines. The only changes that will be required at scattered points across the codebase are the `psl::validate()` call sites that will need to receive a `Vec<Box<Path>, SourceFile>` instead of a single `SourceFile`. This PR does _not_ deal with that, but it makes where these call sites are obvious by what entry points they use: `psl::validate()`, `psl::parse_schema()` and the various `*_assert_single()` methods on `ParserDatabase`. The PR contains tests confirming that schema analysis, validation and displaying diagnostics across multiple files works as expected. Status of this PR ================= This is going to be directly mergeable after review, and it will not affect the current schema handling behaviour when dealing with a single schema file. Next steps ========== - Replace all calls to `psl::validate()` with calls to `psl::validate_multi_file()`. - The `*_assert_single()` calls should be progressively replaced with their multi-file counterparts across engines. - The language server should start sending multiple files to prisma-schema-wasm in all calls. This is not in the spirit of the language server spec, but that is the most immediate solution. We'll have to make `range_to_span()` in `prisma-fmt` multi-schema aware by taking a FileId param. Links ===== Relevant issue: prisma/prisma#2377 Also see the [internal design doc](https://www.notion.so/prismaio/Multi-file-Schema-24d68fe8664048ad86252fe446caac24?d=68ef128f25974e619671a9855f65f44d#2889a038e68c4fe1ac9afe3cd34978bd). * WIP(schema-wasm): Support schema split into multiple files * Reformat support (psl crate) * Add multifile reformatting tests * Clippy * feat(prisma-fmt): addd support for mergeSchemas, expose functions to prisma-fmt-wasm * chore(prisma-fmt): removed unused function * chore: fix typo Co-authored-by: Serhii Tatarintsev <[email protected]> * feat(prisma-fmt): apply validation to merge_schemas * chore(prisma-fmt): update unit test * chore: fix bad merge * chore: fix tests --------- Co-authored-by: Tom Houlé <[email protected]> Co-authored-by: Alberto Schiabel <[email protected]> Co-authored-by: jkomyno <[email protected]>

dashaomai · 2024-04-09T06:20:08Z

Can this resolve the problem?

Prisma-MultiSchema

Messhias · 2024-04-09T09:08:30Z

Can this resolve the problem?

Prisma-MultiSchema

It's solve, but this is the horrible thing about the JS ecosystem; everything it's a lot bundle of packages. In my opinion the Prisma developer should take your package and implement the code into the prisma. Or, you create a pull request that envolve the package.

Personally I'll wouldn't install more JS packages to solve an issue of an JS package. If you think about it, is something quite bad for community.

nlynzaad · 2024-04-09T11:45:09Z

looking at PR 4243 and PR 4787 it looks like we may soon have native support in prisma.

janpio · 2024-04-09T12:20:08Z

Well spotted @nlynzaad, we have indeed started work on this functionality.
We'll post an update here when there is something ready to play and test with.

…prisma#2377 is resolved through prisma-multischema

divmgl · 2024-04-24T14:51:48Z

#2377 (comment) No need for this. I didn't see anything too unreasonable.

Looking forward to this feature. It'd be nice if we could target a folder and all of the schema files within that folder get picked up. Similar to how HCL with Terraform works.

prisma generate --schema ./schema
# Targets the entire ./schema folder, picks up all schema files within it Terraform style

This commit implements multi-file schema handling in the Prisma Schema Language. At a high level, instead of accepting a single string, `psl::validate_multi_file()` is an alternative to `psl::validate()` that accepts something morally equivalent to: ```json { "./prisma/schema/a.prisma": "datasource db { ... }", "./prisma/schema/nested/b.prisma": "model Test { ... }" } ``` There are tests for PSL validation with multiple schema files, but most of the rest of engines still consumes the single file version of `psl::validate()`. The implementation and the return type are shared between `psl::validate_multi_file()` and `psl::validate()`, so the change is completely transparent, other than the expectation of passing in a list of (file_name, file_contents) instead of a single string. The `psl::validate()` entry point should behave exactly the same as `psl::multi_schema()` with a single file named `schema.prisma`. In particular, it has the exact same return type. Implementation ============== This is achieved by extending `Span` to contain, in addition to a start and end offset, a `FileId`. The `FileId` is a unique identifier for a file and its parsed `SchemaAst` inside `ParserDatabase`. The identifier types for AST items in `ParserDatabase` are also extended to contain the `FileId`, so that they can be uniquely referred to in the context of the (multi-file) schema. After the analysis phase (the `parser_database` crate), consumers of the analyzed schema become multi-file aware completely transparently, no change is necessary in the other engines. The only changes that will be required at scattered points across the codebase are the `psl::validate()` call sites that will need to receive a `Vec<Box<Path>, SourceFile>` instead of a single `SourceFile`. This PR does _not_ deal with that, but it makes where these call sites are obvious by what entry points they use: `psl::validate()`, `psl::parse_schema()` and the various `*_assert_single()` methods on `ParserDatabase`. The PR contains tests confirming that schema analysis, validation and displaying diagnostics across multiple files works as expected. Status of this PR ================= This is going to be directly mergeable after review, and it will not affect the current schema handling behaviour when dealing with a single schema file. Next steps ========== - Replace all calls to `psl::validate()` with calls to `psl::validate_multi_file()`. - The `*_assert_single()` calls should be progressively replaced with their multi-file counterparts across engines. - The language server should start sending multiple files to prisma-schema-wasm in all calls. This is not in the spirit of the language server spec, but that is the most immediate solution. We'll have to make `range_to_span()` in `prisma-fmt` multi-schema aware by taking a FileId param. Links ===== Relevant issue: prisma/prisma#2377 Also see the [internal design doc](https://www.notion.so/prismaio/Multi-file-Schema-24d68fe8664048ad86252fe446caac24?d=68ef128f25974e619671a9855f65f44d#2889a038e68c4fe1ac9afe3cd34978bd).

aseemk · 2024-05-17T18:17:14Z

Well spotted @nlynzaad, we have indeed started work on this functionality. We'll post an update here when there is something ready to play and test with.

This is awesome @janpio, thank you! Our own schema file is at almost 1,500 LOC now, so we'd love a split. =)

If it's helpful from a design perspective, just wanted to request the ability for schema files to be split up across separate folders too, not necessarily all in one. We organize our codebase how the OP here described:

flexible integration with certain architectures, i.e. each module has its own self-contained logic including its schema

(And we've been finding that extremely nice and helpful.)

Thanks again!

darkartur · 2024-05-25T10:20:07Z

No with react native support this makes even more sense if someone decides to share schema between backend and react native app

dolapo1 · 2024-05-30T04:26:19Z

Create a folder called models in your prisma folder, then add our files to it:

mkdir prisma/models
touch prisma/models/config.prisma
touch prisma/models/user.prisma
touch prisma/models/post.prisma

config.prisma

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

user.prisma

model User {
  id        Int      @id @default(autoincrement())
  username  String   @unique
  email     String   @unique
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  posts     Post[]
}
post.prisma
model Post {
  id        Int      @id @default(autoincrement())
  title     String
  content   String
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  author    User     @relation(fields: [authorId], references: [id])
  authorId  Int
}

The merging step.
This is where the magic happens, thanks to a single command, we will merge our models into the main schema.prisma file:

cd ./prisma/models && rm -rf ../schema.prisma && cat *.prisma >> ../schema.prisma && cd .. && prisma format
Breakdown of the command:

We change the current dir

cd ./prisma/models
We delete the content of the main file

rm -rf ../schema.prisma
We add the content of our models to the main file

cat *.prisma >> ../schema.prisma
We format and fix errors

prisma format You can add the following to your package.json so that you can just run npm run gen:schema:

"gen:schema": "cd ./prisma/models && rm -rf ../schema.prisma && cat *.prisma >> ../schema.prisma && cd .. && prisma format",
After this step, just run

npx prisma migrate dev --name init

dolapo1 · 2024-05-30T04:26:58Z

I found this somewhere.

nlynzaad · 2024-05-31T18:52:08Z

seems like the wait is just about over PR
X (Twitter) Teaser

Huge thanks to all the developers for their efforts on this. Been stalking the pull requests on this and it seems to have been quite the undertaking

janpio · 2024-06-04T15:57:18Z

Hey, we just released support for multiple-file Prisma Schema setups! It is behind the prismaSchemaFolder preview feature:

Release Notes: https://github.com/prisma/prisma/releases/tag/5.15.0
Documentation: https://prisma.io/docs/orm/prisma-schema/overview/location#multi-file-prisma-schema
Announcement blog post: https://www.prisma.io/blog/organize-your-prisma-schema-with-multi-file-support

Please try it out and leave feedback in this discussion: #24413

albertoperdomo added kind/feature A request for a new feature. topic: schema team/product labels May 5, 2020

albertoperdomo mentioned this issue May 13, 2020

Separate prisma files to manage models #92

Closed

pantharshit00 mentioned this issue Jun 1, 2020

Import .prisma files inside .prisma file #2628

Closed

macrozone mentioned this issue Jul 9, 2020

Import Schema definitions/interfaces from modules #2977

Open

SigurdMW mentioned this issue Sep 11, 2020

How to break .prisma file into smaller modules? blitz-js/legacy-framework#748

Closed

This comment has been minimized.

Sign in to view

thebiglabasky mentioned this issue Nov 30, 2020

Deprecation of provider array notation #3834

Closed

janpio removed the team/product label Dec 11, 2020

Riron mentioned this issue Jan 13, 2021

Mod/prisma MTES-MCT/trackdechets#733

Merged

matthewmueller added the domain/schema Issue in the "Schema" domain: Prisma Schema, Introspection, Migrations etc. label Jan 14, 2021

matthewmueller added domain/client Issue in the "Client" domain: Prisma Client, Prisma Studio etc. and removed domain/schema Issue in the "Schema" domain: Prisma Schema, Introspection, Migrations etc. labels Jan 25, 2021

matthewmueller added the process/candidate label Feb 16, 2021

mathiasberggren added a commit to mathiasberggren/streaming-subscription that referenced this issue Apr 9, 2024

(feat): Enable having multiple schema files for prisma before prisma/…

2abb199

…prisma#2377 is resolved through prisma-multischema

mathiasberggren mentioned this issue Apr 9, 2024

[Backend] Store scraped movie data mathiasberggren/streaming-subscription#10

Merged

8 tasks

mathiasberggren added a commit to mathiasberggren/streaming-subscription that referenced this issue Apr 13, 2024

(feat): Enable having multiple schema files for prisma before prisma/…

89f2876

…prisma#2377 is resolved through prisma-multischema

mathiasberggren added a commit to mathiasberggren/streaming-subscription that referenced this issue Apr 19, 2024

(feat): Enable having multiple schema files for prisma before prisma/…

e570258

…prisma#2377 is resolved through prisma-multischema

mathiasberggren added a commit to mathiasberggren/streaming-subscription that referenced this issue Apr 19, 2024

(feat): Enable having multiple schema files for prisma before prisma/…

1cd48bd

…prisma#2377 is resolved through prisma-multischema

mathiasberggren added a commit to mathiasberggren/streaming-subscription that referenced this issue Apr 20, 2024

(feat): Enable having multiple schema files for prisma before prisma/…

f669ba4

…prisma#2377 is resolved through prisma-multischema

mathiasberggren added a commit to mathiasberggren/streaming-subscription that referenced this issue Apr 23, 2024

(feat): Enable having multiple schema files for prisma before prisma/…

4175559

…prisma#2377 is resolved through prisma-multischema

This comment was marked as off-topic.

Sign in to view

SevInf mentioned this issue Apr 29, 2024

class based schema design, like typeorm #24003

Closed

This comment was marked as off-topic.

Sign in to view

juliavdkris mentioned this issue May 17, 2024

Split prisma schema into multiple files PRIME-TU-Delft/graaf#25

Open

Jolg42 added this to the 5.15.0 milestone Jun 4, 2024

prisma locked as resolved and limited conversation to collaborators Jun 4, 2024

janpio added the status/is-preview-feature This feature request is currently available as a Preview feature. label Jun 5, 2024

apolanc removed this from the 5.15.0 milestone Jun 6, 2024

janpio removed their assignment Nov 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for splitting Prisma schema into multiple files #2377

Support for splitting Prisma schema into multiple files #2377

albertoperdomo commented May 5, 2020 •

edited by janpio

Loading

ChristophDietrich commented May 8, 2020

paniavula commented May 14, 2020

beeplin commented May 14, 2020

JontyCoertzen commented Jun 2, 2020

SteveSonoa commented Nov 13, 2020

yhaiovyi commented Nov 14, 2020

This comment has been minimized.

This comment has been minimized.

cudba commented Nov 30, 2020

hgezim commented Jan 2, 2021

slinden2 commented Jan 2, 2021

kevinvdburgt commented Jan 26, 2021 •

edited

Loading

yazer79 commented Feb 6, 2021

paulosalvatore commented Feb 7, 2021 •

edited

Loading

ncirkel commented Feb 7, 2021

ChristophDietrich commented Feb 7, 2021

dashaomai commented Apr 9, 2024

Messhias commented Apr 9, 2024

nlynzaad commented Apr 9, 2024

janpio commented Apr 9, 2024

divmgl commented Apr 24, 2024 •

edited

Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

aseemk commented May 17, 2024

darkartur commented May 25, 2024

dolapo1 commented May 30, 2024 •

edited by janpio

Loading

dolapo1 commented May 30, 2024

nlynzaad commented May 31, 2024 •

edited

Loading

janpio commented Jun 4, 2024 •

edited

Loading

Support for splitting Prisma schema into multiple files #2377

Support for splitting Prisma schema into multiple files #2377

Comments

albertoperdomo commented May 5, 2020 • edited by janpio Loading

Problem

Solution

Alternatives

Additional context

ChristophDietrich commented May 8, 2020

paniavula commented May 14, 2020

beeplin commented May 14, 2020

JontyCoertzen commented Jun 2, 2020

SteveSonoa commented Nov 13, 2020

yhaiovyi commented Nov 14, 2020

This comment has been minimized.

This comment has been minimized.

cudba commented Nov 30, 2020

hgezim commented Jan 2, 2021

slinden2 commented Jan 2, 2021

kevinvdburgt commented Jan 26, 2021 • edited Loading

yazer79 commented Feb 6, 2021

paulosalvatore commented Feb 7, 2021 • edited Loading

ncirkel commented Feb 7, 2021

ChristophDietrich commented Feb 7, 2021

dashaomai commented Apr 9, 2024

Messhias commented Apr 9, 2024

nlynzaad commented Apr 9, 2024

janpio commented Apr 9, 2024

divmgl commented Apr 24, 2024 • edited Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

aseemk commented May 17, 2024

darkartur commented May 25, 2024

dolapo1 commented May 30, 2024 • edited by janpio Loading

dolapo1 commented May 30, 2024

nlynzaad commented May 31, 2024 • edited Loading

janpio commented Jun 4, 2024 • edited Loading

albertoperdomo commented May 5, 2020 •

edited by janpio

Loading

kevinvdburgt commented Jan 26, 2021 •

edited

Loading

paulosalvatore commented Feb 7, 2021 •

edited

Loading

divmgl commented Apr 24, 2024 •

edited

Loading

dolapo1 commented May 30, 2024 •

edited by janpio

Loading

nlynzaad commented May 31, 2024 •

edited

Loading

janpio commented Jun 4, 2024 •

edited

Loading