-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(recipes): prisma usage #58
Open
smarroufin
wants to merge
4
commits into
main
Choose a base branch
from
docs/38-prisma-usage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,182 @@ | ||
--- | ||
title: Prisma ORM | ||
description: Learn how to setup Prisma ORM with NuxtHub. | ||
--- | ||
|
||
::alert{icon="i-ph-warning" color="red" title="WIP"} | ||
This ORM is not fully compatible with NuxtHub yet. | ||
:br | ||
- Deployment has an addressed issue, that will be solved soon ([unwasm/issues#21](https://github.com/unjs/unwasm/issues/21){target=_blank}). | ||
:: | ||
|
||
::callout{icon="i-ph-link" to="https://www.prisma.io/orm" external} | ||
Learn more about **Prisma ORM**. | ||
:: | ||
|
||
## Setup | ||
|
||
To enhance your Developer Experience with the database, we can use the `nuxt-prisma` module with a few steps. | ||
|
||
### 1. Install Prisma | ||
|
||
Install the `@prisma/nuxt` and `@prisma/adapter-d1` packages to your project: | ||
|
||
::code-group | ||
```bash [pnpm] | ||
pnpm add @prisma/nuxt @prisma/adapter-d1 | ||
``` | ||
```bash [yarn] | ||
yarn add @prisma/nuxt @prisma/adapter-d1 | ||
``` | ||
```bash [npm] | ||
npm install @prisma/nuxt @prisma/adapter-d1 | ||
``` | ||
```bash [bun] | ||
bun add @prisma/nuxt @prisma/adapter-d1 | ||
``` | ||
:: | ||
|
||
### 2. Init Prisma | ||
|
||
Add `@prisma/nuxt` to the `modules` section of `nuxt.config.ts` | ||
```javascript | ||
export default defineNuxtConfig({ | ||
modules: ["@prisma/nuxt"], | ||
}); | ||
|
||
To generate needed directories and files, run this command: | ||
|
||
```bash | ||
npx prisma init --datasource-provider sqlite | ||
``` | ||
|
||
Now you have `.prisma/schema.prisma` in your project, make it match this config: | ||
|
||
```[schema.prisma] | ||
generator client { | ||
provider = "prisma-client-js" | ||
// preview feature enabling binding adapter | ||
previewFeatures = ["driverAdapters"] | ||
} | ||
|
||
datasource db { | ||
provider = "sqlite" | ||
// url is required but won't be used | ||
url = env("DATABASE_URL") | ||
} | ||
``` | ||
|
||
::note | ||
No need to define `DATABASE_URL` in your `.env` file, it won't be used. | ||
:: | ||
|
||
### Create Models | ||
|
||
Your models are defined in the same file as the rest of Prisma config, `schema.prisma`. Let's add a model: | ||
|
||
```[schema.prisma] | ||
model Todos { | ||
id Int @id @default(autoincrement()) | ||
title String | ||
completed Boolean @default(false) | ||
createdAt DateTime @default(now()) | ||
} | ||
``` | ||
|
||
::callout{icon="i-ph-link" to="https://www.prisma.io/docs/orm/prisma-schema/data-model/models" external} | ||
Prisma's documentation is a great resource to learn how to create the models you need. | ||
:: | ||
|
||
### 4. Generate Prisma Client | ||
|
||
Run this command to generate Prisma client: | ||
|
||
```bash | ||
npx prisma generate | ||
``` | ||
|
||
::note | ||
Don't forget to run this command each time you update your `schema.prisma` file. | ||
:: | ||
|
||
#### Example | ||
|
||
The [nuxt-prisma-nuxt-module](https://github.com/prisma/prisma-examples/tree/latest/typescript/nuxt-prisma-nuxt-module) example shows how `@prisma/nuxt` is used. | ||
|
||
|
||
### 5. Migrations | ||
|
||
::callout{icon="i-ph-link" to="https://www.prisma.io/docs/orm/overview/databases/cloudflare-d1#migration-workflows" external} | ||
Prisma Migrate does not fully support migrations with D1, but it is possible. See the link for a full guide. | ||
:: | ||
|
||
## Usage | ||
|
||
### Select | ||
|
||
```ts [server/api/todos/index.get.ts] | ||
export default eventHandler(async () => { | ||
const todos = await usePrismaClient().todos.findMany() | ||
|
||
return todos | ||
}) | ||
``` | ||
|
||
### Insert | ||
|
||
```ts [server/api/todos/index.post.ts] | ||
export default eventHandler(async (event) => { | ||
const { title } = await readBody(event) | ||
|
||
const todo = await usePrismaClient().todos.create({ | ||
data: { | ||
title, | ||
createdAt: new Date() | ||
} | ||
}) | ||
|
||
return todo | ||
}) | ||
``` | ||
|
||
### Update | ||
|
||
```ts [server/api/todos/[id].patch.ts] | ||
export default eventHandler(async (event) => { | ||
const { id } = getRouterParams(event) | ||
const { completed } = await readBody(event) | ||
|
||
const todo = await usePrismaClient().todos.update({ | ||
where: { | ||
id: Number(id) | ||
}, | ||
data: { | ||
completed | ||
} | ||
}) | ||
|
||
return todo | ||
}) | ||
``` | ||
|
||
### Delete | ||
|
||
```ts [server/api/todos/[id].delete.ts] | ||
export default eventHandler(async (event) => { | ||
const { id } = getRouterParams(event) | ||
|
||
const deletedTodo = await usePrismaClient().todos.delete({ | ||
where: { | ||
id: Number(id) | ||
} | ||
}) | ||
|
||
if (!deletedTodo) { | ||
throw createError({ | ||
statusCode: 404, | ||
message: 'Todo not found' | ||
}) | ||
} | ||
return deletedTodo | ||
}) | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.