Nexus Framework Prisma Users

Enabling CRUD capabilities

If you were using t.crud with the framework, you must also explicitly enable it with the schema plugin

1import { makeSchema } from 'nexus'
2import { nexusPrisma } from 'nexus-plugin-prisma'
3
4makeSchema({
5  plugins: [nexusPrisma({
+   experimentalCRUD: true
7  })]
8})

Configuring Backing types

To let nexus know of the Prisma Client types so that, for instance, your resolvers expect the right types, you must point makeSchema to the Prisma Client where all the types are exported.

1import { makeSchema } from 'nexus'
2import { nexusPrisma } from 'nexus-plugin-prisma'
3
4export const schema = makeSchema({
+  sourceTypes: {
+    modules: [
+      {
+        module: require.resolve('.prisma/client/index.d.ts'),
+        alias: "prisma",
+      }
+    ]
+  }
13  plugins: [
14    nexusPrisma({
15      experimentalCRUD: true
16    })
17  ]
18})

Configuring Context Type

The framework used to automatically inject and type your context so that an instance of the client would be there for you. We now need to configure that manually. To do so, we'll first create a context.ts file where we'll export a type containing the Prisma Client.

1// context.ts
2import { PrismaClient } from '@prisma/client'
3
4export type Context = {
5  db: PrismaClient
6}

Then, we'll go back to the file where we're calling makeSchema, and add the following configuration

1import { makeSchema } from 'nexus'
2import { nexusPrisma } from 'nexus-plugin-prisma'
3
4export const schema = makeSchema({
5  sourceTypes: {
6    modules: [
7      {
8        source: require.resolve('.prisma/client/index.d.ts'),
9        alias: "prisma",
10      },
11    ],
+   contextType: {
+     source: require.resolve('./context'),
+     alias: 'ContextModule'
+   }
16  }
17  plugins: [
18    nexusPrisma({
19      experimentalCRUD: true
20    })
21  ]
22})

Configuring Custom Scalars

If your Prisma Schema is using either the Json or DateTime type, the framework used to provide some GraphQL scalars to map these. With nexus, you will need to install and do the mapping yourself.

1. Start by installing the following dependency

   1npm install graphql-scalars
   2```xf
   3

2. Then, add the following configuration property to the Prisma plugin

   1import { makeSchema } from 'nexus'
   2import { nexusPrisma } from 'nexus-plugin-prisma'
   +import { DateTimeResolver, JSONObjectResolver } from 'graphql-scalars'
   4
   5export const schema = makeSchema({
   6  sourceTypes: {
   7    modules: [
   8      {
   9        module: require.resolve('.prisma/client/index.d.ts'),
   10        alias: "prisma",
   11      },
   12    ],
   13    contextType: {
   14      module: require.resolve('./context'),
   15      alias: 'ContextModule'
   16    }
   17  }
   18  plugins: [
   19    nexusPrisma({
   20      experimentalCRUD: true
   +     scalars: {
   +       DateTime: DateTimeResolver,
   +       Json: new GraphQLScalarType({
   +         ...JSONObjectResolver,
   +         name: 'Json',
   +         description: 'The `JSON` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).',
   +       })
   +     }
   29    })
   30  ]
   31})