Clone this repository:

git clone git@github.com:prisma/prisma-examples.git --depth=1

Install npm dependencies:

cd prisma-examples/orm/nextjs-graphql
npm install

Let's set up your Prisma Postgres database!
? Select your region: ap-northeast-1 - Asia Pacific (Tokyo)
? Enter a project name: testing-migration
✔ Success! Your Prisma Postgres database is ready ✅

We found an existing schema.prisma file in your current project directory.

--- Database URL ---

Connect Prisma ORM to your Prisma Postgres database with the provided URL. Add it to your `.env` as `DATABASE_URL`.

--- Next steps ---

Go to https://pris.ly/ppg-init for detailed instructions.

1. Install the `@prisma/adapter-pg` driver adapter and configure your Prisma Client instance
```bash
npm install @prisma/adapter-pg

import { PrismaPg } from '@prisma/adapter-pg'
const pool = new PrismaPg({ connectionString: process.env.DATABASE_URL! })
const prisma = new PrismaClient({ adapter: pool })

2. Apply migrations Run the following command to create and apply a migration: npx prisma migrate dev

3. Manage your data View and edit your data locally by running this command: npx prisma studio

...or online in Console: https://console.prisma.io/{workspaceId}/{projectId}/studio

4. Send queries from your app If you already have an existing app with Prisma ORM, you can now run it and it will send queries against your newly created Prisma Postgres instance.

5. Learn more For more info, visit the Prisma Postgres docs: https://pris.ly/ppg-docs

</details>

Locate and copy the database URL provided in the CLI output. Then, create a `.env` file in the project root:

```bash
touch .env

Now, paste the URL into it as a value for the DATABASE_URL environment variable. For example:

# .env
DATABASE_URL=postgres://<username>:<password>@<host>:<port>/<database>

Run the following command to create tables in your database. This creates the User and Post tables that are defined in prisma/schema.prisma:

npx prisma migrate dev --name init

Execute the seed file in prisma/seed.ts to populate your database with some sample data, by running:

npx prisma db seed

npm run dev

The app is now running, navigate to http://localhost:3000/ in your browser to explore its UI.

You can also access the GraphQL API of the API server directly. It is running on the same host machine and port and can be accessed via the /api/graphql route (in this case that is localhost:3000/api/graphql).

Below are a number of operations that you can send to the API.

query {
  feed {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

mutation {
  signupUser(name: "Sarah", email: "sarah@prisma.io") {
    id
  }
}

mutation {
  createDraft(
    title: "Join the Prisma Discord"
    content: "https://pris.ly/discord"
    authorEmail: "alice@prisma.io"
  ) {
    id
    published
  }
}

mutation {
  publish(postId: "__POST_ID__") {
    id
    published
  }
}

{
  filterPosts(searchString: "graphql") {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

{
  post(postId: "__POST_ID__") {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

mutation {
  deletePost(postId: "__POST_ID__") {
    id
  }
}

Evolving the application typically requires three steps:

1. Migrate your database using Prisma Migrate
2. Update your server-side application code
3. Build new UI features in React

For the following example scenario, assume you want to add a "profile" feature to the app where users can create a profile and write a short bio about themselves.

The first step is to add a new table, e.g. called Profile, to the database. You can do this by adding a new model to your Prisma schema file file and then running a migration afterwards:

// ./prisma/schema.prisma

model User {
  id      Int      @default(autoincrement()) @id
  name    String?
  email   String   @unique
  posts   Post[]
+ profile Profile?
}

model Post {
  id        Int      @id @default(autoincrement())
  title     String
  content   String?
  published Boolean  @default(false)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
}

+model Profile {
+  id     Int     @default(autoincrement()) @id
+  bio    String?
+  user   User    @relation(fields: [userId], references: [id])
+  userId Int     @unique
+}

Once you've updated your data model, you can execute the changes against your database with the following command:

npx prisma migrate dev --name add-profile

This adds another migration to the prisma/migrations directory and creates the new Profile table in the database.

You can now use your PrismaClient instance to perform operations against the new Profile table. Those operations can be used to implement queries and mutations in the GraphQL API.

First, add a new GraphQL type via Pothos's prismaObject function:

// ./pages/api/graphql.ts

+builder.prismaObject('Profile', {
+  fields: (t) => ({
+    id: t.exposeInt('id'),
+    bio: t.exposeString('bio', { nullable: true }),
+    user: t.relation('user'),
+  }),
+})

builder.prismaObject('User', {
  fields: (t) => ({
    id: t.exposeInt('id'),
    name: t.exposeString('name', { nullable: true }),
    email: t.exposeString('email'),
    posts: t.relation('posts'),
+    profile: t.relation('profile'),
  }),
})

// ./pages/api/graphql.ts

// other object types, queries and mutations


+builder.mutationField('createProfile', (t) =>
+  t.prismaField({
+    type: 'Profile',
+    args: {
+      bio: t.arg.string({ required: true }),
+      data: t.arg({ type: UserUniqueInput })
+    },
+    resolve: async (query, _parent, args, _context) =>
+      prisma.profile.create({
+        ...query,
+        data: {
+          bio: args.bio,
+          user: {
+            connect: {
+              id: args.data?.id || undefined,
+              email: args.data?.email || undefined
+            }
+          }
+        }
+      })
+  })
+)

Finally, you can test the new mutation like this:

mutation {
  createProfile(
    email: "mahmoud@prisma.io"
    bio: "I like turtles"
  ) {
    id
    bio
    user {
      id
      name
    }
  }
}

const profile = await prisma.profile.create({
  data: {
    bio: 'Hello World',
    user: {
      connect: { email: 'alice@prisma.io' },
    },
  },
})

const user = await prisma.user.create({
  data: {
    email: 'john@prisma.io',
    name: 'John',
    profile: {
      create: {
        bio: 'Hello World',
      },
    },
  },
})

const userWithUpdatedProfile = await prisma.user.update({
  where: { email: 'alice@prisma.io' },
  data: {
    profile: {
      update: {
        bio: 'Hello Friends',
      },
    },
  },
})

Once you have added a new query or mutation to the API, you can start building a new UI component in React. It could e.g. be called profile.tsx and would be located in the pages directory.

In the application code, you can access the new operations via Apollo Client and populate the UI with the data you receive from the API calls.

If you want to try this example with another database than Postgres, you can adjust the the database connection in prisma/schema.prisma by reconfiguring the datasource block.

Learn more about the different connection configurations in the docs.

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

DATABASE_URL="file:./dev.db""

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

## This is a placeholder url
DATABASE_URL="mysql://janedoe:mypassword@localhost:3306/notesapi"

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

## This is a placeholder url
DATABASE_URL="sqlserver://localhost:1433;initial catalog=sample;user=sa;password=mypassword;"

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

## This is a placeholder url
DATABASE_URL="mongodb://USERNAME:PASSWORD@HOST/DATABASE?authSource=admin&retryWrites=true&w=majority"

• Check out the Prisma docs
• Join our community on Discord to share feedback and interact with other users.
• Subscribe to our YouTube channel for live demos and video tutorials.
• Follow us on X for the latest updates.
• Report issues or ask questions on GitHub.