Prisma

Before you start

Configure the Prisma Language Server

Prisma ORM support in WebStorm is backed by the Prisma Language Server. WebStorm is shipped with a bundled Prisma Language Server. However, it is recommended that you keep the Language Server up to date

Code completion

WebStorm provides Prisma Schema Language-aware code completion in schema files including documentation for selected completion suggestions.

Code inspection

You can view Prisma LSP diagnostics right in the editor on hovering over a highlighted code element where a problem is detected.

Detected errors are shown in the Problems tool window and in a popup right in the editor on hover.

• Missing mandatory attributes

  

• Missing binary targets

• Missing @@schema attributes are detected and a quick-fix is suggested.

  

Documentation look-up

WebStorm shows documentation for various Prisma-specific symbols, including datasource and generator blocks.

The Documentation popup is displayed when you hover over a symbol in the editor or press Ctrl+Q, as well as on code completion.

To view documentation for a symbol in the Structure tool window, select the symbol and press Ctrl+Q.

Learn more from Code reference information.

Comments

You can add comments above, below, and inside data models. Multiline comments are welcome.

To add a comment, start typing /** and press Enter. WebStorm adds the closing */ and * at the beginning of each line.

Hovering over a symbol shows the comment in the Documentation popup with proper formatting.

Alternatively, examine comments in the Rendered View mode. For that, click in the gutter next to a comment or press Ctrl+Alt+Q.

To view the comment in the Documentation tool window, hover over a symbol, click in the Documentation popup, and then select Open in Documentation Tool Window.

Structure view

With WebStorm, you can view and navigate the structure of schema files in the Structure tool window (Alt+7). The tool window is synchronized with the currently open Prisma Schema, so when you select an item in the tool window, it is automatically selected in the schema file.

Block-specific coding assistance

Multi-file Prisma schemas

In WebStorm, you can work with Prisma schemas that are split across multiple files, providing completion, documentation, navigation, search, and more.

• WebStorm supports connection via @relation across files located in the same directory, or in its subdirectories, or in different directories. Newly added relations are reformatted automatically.

• Multifile schemas located in subdirectories are recognized by npx prisma generate.

• Code completion and quick documentation is provided for relations and types.

• You can find the usages of a symbol across the project with Alt+F7.

  

  To jump to the declaration of a symbol, press Ctrl+B.

• You can view quick documentation for models specified in other .prisma files.

  

• A dedicated inspection detects duplicates of generator and datasource blocks and shows an error in the Problems tool window and in a popup right in the editor on hover.

  

Sharding

For Prisma ORM 6.10 and later, WebStorm supports sharding via the @shardKey and @@shardKey attributes, so you can easier scale up when your database load grows.

To work with sharding, make sure to add previewFeatures = ["shardKeys"] to the generator block.

• Code completion and quick documentation lookup for @shardKey and @@shardKey.

  

• Completion for fields within the block attribute @@shardKey. Completion list only includes scalar non-nullable fields

  

• You can search for usages of fields within @@shardKey block attributes with Alt+F7.

  

• You can apply the Rename refactoring to fields within @@shardKey block attributes.