Skip to content

Commit

Permalink
chore(d1): update README for Preview (#23491)
Browse files Browse the repository at this point in the history
Co-authored-by: jkomyno <skiabo97@gmail.com>
  • Loading branch information
Jolg42 and jkomyno committed Apr 2, 2024
1 parent 3d415f0 commit 4f51dba
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions packages/adapter-d1/README.md
Expand Up @@ -2,13 +2,10 @@

Prisma driver adapter for [Cloudflare's D1 database](https://developers.cloudflare.com/d1/).

> [!IMPORTANT]
> We do not recommend using the adapter in a production environment yet.
> The adapter is currently in [Early Access](https://www.prisma.io/docs/orm/more/releases#early-access), we are looking for feedback before moving to Preview.
> [!NOTE]
> The adapter is currently in [Preview](https://www.prisma.io/docs/orm/more/releases#early-access), we are looking for feedback before moving to General Availability.
<!-- TODO Refer to the [announcement blog post](https://prisma.io/cloudflare-d1) and our [docs](https://www.prisma.io/docs/guides/database/cloudflare-d1) for more details. -->

<!-- > **Note**: Support for Cloudflare D1 is available in [Early Access](https://www.prisma.io/docs/about/prisma/releases#early-access) from Prisma versions [TODO](https://github.com/prisma/prisma/releases/tag/TODO) and later. -->
Refer to the [announcement blog post](https://prisma.io/cloudflare-d1) and our [docs](https://www.prisma.io/docs/orm/overview/databases/cloudflare-d1) for more details.

## Getting started

Expand All @@ -30,9 +27,9 @@ datasource db {
Install Prisma CLI, Prisma Client, the Prisma adapter for Cloudflare D1, the TypeScript types for Cloudflare Workers, and Wrangler CLI packages:

```sh
npm install @prisma/client@early-access
npm install @prisma/adapter-d1@early-access
npm install --save-dev prisma@early-access
npm install @prisma/client
npm install @prisma/adapter-d1
npm install --save-dev prisma
npm install --save-dev @cloudflare/workers-types
npm install --save-dev wrangler
```
Expand Down Expand Up @@ -105,10 +102,12 @@ export default {
> database_id = "<unique-ID-for-your-database>"
> ```
<!-- TODO Refer to our [docs](https://www.prisma.io/docs/guides/database/cloudflare-d1#how-to-manage-schema-changes) to learn how to manage schema changes when using Prisma and Cloudflare D1. -->
## Migrations

Please refer to our [docs](https://www.prisma.io/docs/orm/overview/databases/cloudflare-d1#migration-workflows) to learn how to manage schema changes when using Prisma and Cloudflare D1.

## Feedback

<!-- ## Feedback
TODO Leave this till preview
We encourage you to create an issue if you find something missing or run into a bug.

If you have any feedback, leave a comment in [this GitHub discussion](https://github.com/prisma/prisma/discussions/TODO). -->
If you have any feedback, leave a comment in [this GitHub discussion](https://github.com/prisma/prisma/discussions/23646).

0 comments on commit 4f51dba

Please sign in to comment.