diff --git a/apps/blog/content/blog/data-migrations-in-prisma-next/index.mdx b/apps/blog/content/blog/data-migrations-in-prisma-next/index.mdx index ded520660c..2fb7e1367c 100644 --- a/apps/blog/content/blog/data-migrations-in-prisma-next/index.mdx +++ b/apps/blog/content/blog/data-migrations-in-prisma-next/index.mdx @@ -216,4 +216,4 @@ This command will set up Prisma Next in a new or existing project with a simple Tell us what worked and what didn't on [Discord](https://pris.ly/discord) in the `#prisma-next` channel, and **star and watch [prisma/prisma-next](https://pris.ly/pn-gh) on GitHub** to follow development. We'd love to hear your feedback! -Be aware that Prisma Next is not production-ready yet. Prisma 7 is still the right choice for production today. When Prisma Next is ready for general use, it becomes Prisma 8. +Prisma Next is in Early Access. Prisma 7 is the current generally available release, so if you're using it, keep using it. When Prisma Next is ready for general use, it becomes Prisma 8. diff --git a/apps/blog/content/blog/mongodb-without-compromise/index.mdx b/apps/blog/content/blog/mongodb-without-compromise/index.mdx index 8b5944a6ea..35938f7208 100644 --- a/apps/blog/content/blog/mongodb-without-compromise/index.mdx +++ b/apps/blog/content/blog/mongodb-without-compromise/index.mdx @@ -235,7 +235,7 @@ The ORM ecosystem has plenty of healthy competition, and we wanted to make sure ## Where we are, where we're going -Prisma Next is still in its early stages and isn't ready for production use yet. For production applications, Prisma 7 is still the recommended choice. Once Prisma Next is ready for general use, it will become Prisma 8, and upgrading will be a smooth process. +Prisma Next is in Early Access. Prisma 7 is the current generally available release, so if you're using it, keep using it. Once Prisma Next is ready for general use, it will become Prisma 8, and upgrading will be a smooth process. **What works today**: diff --git a/apps/blog/content/blog/prisma-next-call-for-extension-authors/index.mdx b/apps/blog/content/blog/prisma-next-call-for-extension-authors/index.mdx index 3601d83f1e..8befb897dc 100644 --- a/apps/blog/content/blog/prisma-next-call-for-extension-authors/index.mdx +++ b/apps/blog/content/blog/prisma-next-call-for-extension-authors/index.mdx @@ -145,6 +145,6 @@ Build it, then tell us about it in [`#prisma-next`](https://pris.ly/discord) on Prisma Next is early, and the SPI is stable enough that the existing extensions are real proof of what's possible, though we expect to iterate as more of you build against it. -Prisma 7 remains the right choice for production today, and Prisma Next will become Prisma 8 once it's ready for general use. +Prisma Next is in Early Access, and Prisma 7 is the current generally available release, so if you're using it, keep using it. Prisma Next will become Prisma 8 once it's ready for general use. The most interesting extensions will be the ones you'll write. diff --git a/apps/blog/content/blog/the-next-evolution-of-prisma-orm/index.mdx b/apps/blog/content/blog/the-next-evolution-of-prisma-orm/index.mdx index e18302f8da..af401877a9 100644 --- a/apps/blog/content/blog/the-next-evolution-of-prisma-orm/index.mdx +++ b/apps/blog/content/blog/the-next-evolution-of-prisma-orm/index.mdx @@ -441,7 +441,7 @@ If you're shipping today while following this work, start with [Prisma ORM](http ## We’re working in the open -Today we’re publishing the Prisma Next repo so you can follow the work as it happens. Even though it's early and not yet production-ready, we’re sharing it now so the community can see where we’re headed and help shape the design. +Today we’re publishing the Prisma Next repo so you can follow the work as it happens. It’s in Early Access, and we’re sharing it now so the community can see where we’re headed and help shape the design. If you want to stay close to the work, **star + watch** the repo. diff --git a/apps/docs/content/docs/(index)/index.mdx b/apps/docs/content/docs/(index)/index.mdx index a448129859..7cd04a6092 100644 --- a/apps/docs/content/docs/(index)/index.mdx +++ b/apps/docs/content/docs/(index)/index.mdx @@ -24,6 +24,12 @@ npx create-db@latest npx @prisma/cli@latest app deploy ``` +:::note + +Curious what's next? [Prisma Next](/next) is the next major version of Prisma ORM, available now in Early Access. Explore the new developer experience whenever you're ready. + +::: + { + console.error(error); + process.exit(1); +}); +``` + +Run it: + +```npm +npx tsx script.ts +``` + +## 7. Run a simple low-level query + +After the ORM example, this step shows the lower-level MongoDB pipeline builder against the same existing collections. + +Replace `script.ts` with this version: + +```typescript title="script.ts" +import "dotenv/config"; +import { db } from "./prisma/db"; + +async function main() { + const runtime = await db.runtime(); + const plan = db.query + .from("users") + .match((fields) => fields.email.eq("existing@example.com")) + .project("email", "name") + .build(); + + const rows = await runtime.execute(plan); + console.log(rows); + + await db.close(); +} + +main().catch((error) => { + console.error(error); + process.exit(1); +}); +``` + +Run it again: + +```npm +npx tsx script.ts +``` + +## 8. Next steps + +When you change `prisma/contract.prisma`, emit the contract again: + +```npm +npx prisma-next contract emit +``` + +You do not need a migration just to read collections that already exist. Use [migration plan](/cli/next/migration-plan) when you want Prisma Next to own a schema change. diff --git a/apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx b/apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx new file mode 100644 index 0000000000..970578f064 --- /dev/null +++ b/apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx @@ -0,0 +1,176 @@ +--- +title: PostgreSQL +description: Add Prisma Next to an existing PostgreSQL project. +url: /next/add-to-existing-project/postgresql +metaTitle: Add Prisma Next to an existing PostgreSQL project +metaDescription: Add Prisma Next to an existing PostgreSQL project. +--- + +This guide shows how to add Prisma Next to a project that already uses PostgreSQL. You will run `prisma-next init`, infer a contract from the live schema, sign the database, and run a couple of queries. + +Use this path when you already have an application and database. Make sure the app can already reach its PostgreSQL database and runs on Node.js 24 or newer. If you want Prisma Next to create a new app for you, use the [PostgreSQL quickstart](/next/quickstart/postgresql). + +:::note[Prisma Next is in Early Access] + +Prisma Next is the next major version of Prisma ORM, available now in Early Access. It’s the cutting-edge version of Prisma ORM and will become the future of Prisma, so we’d love for you to try it, explore what’s new, and [share your feedback in Discord](https://pris.ly/discord). + +If you want to stay on the current generally available version of Prisma ORM, you can continue with [Prisma 7](/getting-started). + +::: + +## 1. Make sure you can run the example script + +If your project already runs TypeScript scripts, you can skip this step. + +Otherwise, install the script tooling: + +```npm +npm install --save-dev tsx typescript +``` + +Later, `prisma-next init` will also add the Node.js types it needs and make sure the generated Prisma Next files can run as ES modules. If your project already declares `"type": "commonjs"`, Prisma Next leaves that choice alone and prints a warning so you can decide how to wire the generated helper into your app. + +## 2. Initialize Prisma Next + +From the root of your existing project, run: + +```npm +npx prisma-next init --target postgres +``` + +This is the existing-project path. It preselects PostgreSQL, adds Prisma Next files and package scripts to the app you already have, and does not scaffold a new framework project. + +It also adds `prisma-next.md` and project-level Prisma Next skills for Cursor, Claude Code, Codex, and Windsurf so your agent can read the Prisma Next usage, upgrade, and extension-author guidance from the project. + +When Prisma Next asks the remaining setup questions: + +- choose `PSL` +- keep the default schema path, `prisma/contract.prisma` + +## 3. Set your database connection string + +Update `.env` with the connection string for the database your app already uses: + +```text title=".env" +DATABASE_URL="postgres://username:password@host:5432/database?sslmode=require" +``` + +## 4. Infer a starter contract from the live database + +This step gives you a starting contract by reading the schema that already exists in PostgreSQL. + +Run: + +```npm +npx prisma-next contract infer --output ./prisma/contract.prisma +``` + +This reads the live PostgreSQL schema and writes a first draft of `prisma/contract.prisma`. + +Open that file and review it before you go on. This is the moment to clean up model names, keep only the tables you want Prisma Next to know about first, and make the file easier to read. + +## 5. Emit the generated artifacts + +Once the contract looks right, this step turns it into the generated files the runtime and CLI use. + +After you are happy with the contract, run: + +```npm +npx prisma-next contract emit +``` + +This refreshes `prisma/contract.json` and `prisma/contract.d.ts` so the runtime and query APIs are aligned with the contract you just reviewed. + +## 6. Sign the database + +Record that the live database matches the emitted contract: + +```npm +npx prisma-next db sign +``` + +This step matters in two common cases: + +- the database has never been signed by Prisma Next before +- the database was signed earlier, but under an older contract hash + +## 7. Run a simple high-level query + +With the database signed, you can test the higher-level API first and confirm Prisma Next is reading the existing schema correctly. + +Create a `script.ts` file: + +```typescript title="script.ts" +import "dotenv/config"; +import { db } from "./prisma/db"; + +async function main() { + const runtime = await db.connect({ url: process.env.DATABASE_URL! }); + + const users = await db.orm.User + .select("id", "email", "name") + .take(2) + .all(); + + console.log(users); + + await runtime.close(); +} + +main().catch((error) => { + console.error(error); + process.exit(1); +}); +``` + +Run it: + +```npm +npx tsx script.ts +``` + +## 8. Run a simple low-level query + +After the ORM example, this step shows the lower-level SQL builder against the same existing schema. + +Replace `script.ts` with this version: + +```typescript title="script.ts" +import "dotenv/config"; +import { db } from "./prisma/db"; + +async function main() { + const runtime = await db.connect({ url: process.env.DATABASE_URL! }); + + const plan = db.sql.user + .select("id", "email", "name") + .limit(2) + .build(); + + const rows = await db.runtime().execute(plan); + console.log(rows); + + await runtime.close(); +} + +main().catch((error) => { + console.error(error); + process.exit(1); +}); +``` + +Run it again: + +```npm +npx tsx script.ts +``` + +## 9. Next steps + +When you change `prisma/contract.prisma`, emit the contract again: + +```npm +npx prisma-next contract emit +``` + +Use [db update](/cli/next/db-update) for a direct development update, or [migration plan](/cli/next/migration-plan) when you want a checked-in migration. diff --git a/apps/docs/content/docs/(index)/next/getting-started.mdx b/apps/docs/content/docs/(index)/next/getting-started.mdx new file mode 100644 index 0000000000..c4adfa7ac8 --- /dev/null +++ b/apps/docs/content/docs/(index)/next/getting-started.mdx @@ -0,0 +1,62 @@ +--- +title: Choose a setup path +description: Choose the fastest path to try Prisma Next in a new or existing project. +url: /next/getting-started +metaTitle: Prisma Next getting started +metaDescription: Choose a Prisma Next quickstart for a new project or add Prisma Next to an existing app. +badge: early-access +--- + +Start with a quickstart if you want Prisma Next to create the app. Use the existing-project path if you already have an app and database. + +## Start a new project + +```npm +npx create-prisma@next +``` + + + }> + Create the app, choose PostgreSQL, initialize the database, seed data, and run the first query. + + }> + Create the app, choose MongoDB, start or connect to MongoDB, seed data, and run the first query. + + + +## Use Prisma Postgres + +```npm +npx create-prisma@next +``` + + + }> + Create a Prisma Next app and let setup provision Prisma Postgres for the first run. + + }> + Start from the command line when you want the Prisma Postgres path without browsing Console first. + + + +## Add to an existing project + +```npm +npx prisma-next init +``` + + + }> + Add Prisma Next to an existing PostgreSQL app and infer a starter contract from the live schema. + + }> + Add Prisma Next to an existing MongoDB app and model the collections you want to query first. + + + +## After setup + +- Use the generated app scripts for the first run. +- Open `prisma-next.md` or the installed Prisma Next skills when you want agent-ready guidance inside the project. +- Change the starter contract when you are ready to model your own data. +- Open the [Prisma Next overview](/orm/next) when you want the concepts behind the setup. diff --git a/apps/docs/content/docs/(index)/next/index.mdx b/apps/docs/content/docs/(index)/next/index.mdx new file mode 100644 index 0000000000..04fde5d939 --- /dev/null +++ b/apps/docs/content/docs/(index)/next/index.mdx @@ -0,0 +1,60 @@ +--- +title: Introduction to Prisma Next +description: Prisma Next is the next major version of Prisma ORM, available in Early Access. +url: /next +metaTitle: Introduction to Prisma Next +metaDescription: Prisma Next is the next major version of Prisma ORM, available in Early Access. +badge: early-access +--- + +Prisma Next is a ground-up rebuild of Prisma ORM, covering the runtime, query APIs, migration flow, and project setup. + +:::note[Prisma Next is in Early Access] + +Prisma Next is the next major version of Prisma ORM, available now in Early Access. It’s the cutting-edge version of Prisma ORM and will become the future of Prisma, so we’d love for you to try it, explore what’s new, and [share your feedback in Discord](https://pris.ly/discord). + +If you want to stay on the current generally available version of Prisma ORM, you can continue with [Prisma 7](/getting-started). + +::: + +Use Prisma Next when you want to try the new developer experience before it becomes the default Prisma ORM path. + +```npm +npx create-prisma@next +``` + +Start with the setup page when you want a guided first run. + + + }> + Pick a new-project quickstart or add Prisma Next to an existing app. + + + +## What you can try + + + }> + Create a Prisma Next app, initialize the database, seed data, and run the first query. + + }> + Create a Prisma Next app with a local MongoDB replica set or your own MongoDB deployment. + + }> + Add Prisma Next to an existing PostgreSQL app with `prisma-next init`. + + }> + Add Prisma Next to an existing MongoDB app and model the collections you want to query first. + + }> + Create a Prisma Next app backed by Prisma Postgres. + + + +## Learn the concepts + + + }> + Learn the core ideas behind contracts, emitted artifacts, runtime clients, query styles, and migrations. + + diff --git a/apps/docs/content/docs/(index)/next/prisma-postgres/from-the-cli.mdx b/apps/docs/content/docs/(index)/next/prisma-postgres/from-the-cli.mdx new file mode 100644 index 0000000000..3a2239a805 --- /dev/null +++ b/apps/docs/content/docs/(index)/next/prisma-postgres/from-the-cli.mdx @@ -0,0 +1,55 @@ +--- +title: From the CLI +description: Start a Prisma Next app with Prisma Postgres from the command line. +url: /next/prisma-postgres/from-the-cli +metaTitle: Prisma Next with Prisma Postgres from the CLI +metaDescription: Start a Prisma Next app with Prisma Postgres from the command line. +badge: early-access +--- + +Use the CLI when you want Prisma Next and Prisma Postgres set up without leaving the terminal. + +## Start a new app + +```npm +npx create-prisma@next +``` + +Choose PostgreSQL and Prisma Postgres when prompted. + +Setup provisions Prisma Postgres, writes `DATABASE_URL`, adds `prisma-next.md`, installs project-level Prisma Next skills for your coding agent, and writes the generated scripts used below. + +## Initialize the database + +From the generated project directory, run: + +```npm +npm run db:init +``` + +## Seed data + +```npm +npm run db:seed +``` + +## Run the app + +```npm +npm run dev +``` + +## Add Prisma Next to an existing app + +If the app already exists, run Prisma Next from the project root: + +```npm +npx prisma-next init +``` + +Choose PostgreSQL, set `DATABASE_URL` to your Prisma Postgres connection string, and let init add `prisma-next.md`, package scripts, and the Prisma Next skills for your coding agent. Then follow the [PostgreSQL existing-project guide](/next/add-to-existing-project/postgresql). + +## Import an existing database + +- Use [Import from PostgreSQL](/next/prisma-postgres/import-from-existing-database-postgresql) when your source database is PostgreSQL. +- Use [Import from MySQL](/next/prisma-postgres/import-from-existing-database-mysql) when your source database is MySQL. diff --git a/apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-mysql.mdx b/apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-mysql.mdx new file mode 100644 index 0000000000..f98417e5c6 --- /dev/null +++ b/apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-mysql.mdx @@ -0,0 +1,71 @@ +--- +title: Import from MySQL +description: Import an existing MySQL database into Prisma Postgres, then use it with Prisma Next. +url: /next/prisma-postgres/import-from-existing-database-mysql +metaTitle: Import from MySQL into Prisma Postgres for Prisma Next +metaDescription: Import MySQL data into Prisma Postgres, then connect Prisma Next to the imported database. +badge: early-access +--- + +Move an existing MySQL database into Prisma Postgres, then connect Prisma Next to it. + +## Prerequisites + +You need: + +- the connection URL for the MySQL database you are importing from +- a Prisma Data Platform account +- `pgloader` +- Node.js 24 or newer + +## 1. Create a Prisma Postgres database + +Create a Prisma Postgres database from Console or with the CLI. Copy the direct connection string; you will use it for the import and for `DATABASE_URL`. + +## 2. Create a pgloader config + +Create `config.load`: + +```text title="config.load" +LOAD DATABASE + FROM mysql://USER:PASSWORD@HOST:PORT/DATABASE + INTO postgres://USER:PASSWORD@db.prisma.io:5432/?sslmode=require + +WITH quote identifiers, + include drop, + create tables, + create indexes, + reset sequences + +ALTER SCHEMA 'DATABASE' RENAME TO 'public'; +``` + +## 3. Import into Prisma Postgres + +Run pgloader: + +```shell +pgloader config.load +``` + +## 4. Add Prisma Next + +From your app root, initialize Prisma Next: + +```npm +npx prisma-next init +``` + +Choose PostgreSQL, set `DATABASE_URL` to the Prisma Postgres connection string, then infer and emit the contract: + +```npm +npx prisma-next contract infer --output ./prisma/contract.prisma +npx prisma-next contract emit +npx prisma-next db sign +``` + +## Next steps + +- Review table and column names in the inferred contract. +- Use the [PostgreSQL existing-project guide](/next/add-to-existing-project/postgresql) for the first Prisma Next query. +- Use the [full Prisma Postgres MySQL import guide](/prisma-postgres/import-from-existing-database-mysql) for deeper migration details. diff --git a/apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-postgresql.mdx b/apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-postgresql.mdx new file mode 100644 index 0000000000..dea8eb60fa --- /dev/null +++ b/apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-postgresql.mdx @@ -0,0 +1,61 @@ +--- +title: Import from PostgreSQL +description: Import an existing PostgreSQL database into Prisma Postgres, then use it with Prisma Next. +url: /next/prisma-postgres/import-from-existing-database-postgresql +metaTitle: Import from PostgreSQL into Prisma Postgres for Prisma Next +metaDescription: Import PostgreSQL data into Prisma Postgres, then connect Prisma Next to the imported database. +badge: early-access +--- + +Move an existing PostgreSQL database into Prisma Postgres, then connect Prisma Next to it. + +## Prerequisites + +You need: + +- the connection URL for the PostgreSQL database you are importing from +- a Prisma Data Platform account +- PostgreSQL 17 CLI tools, including `pg_dump` and `pg_restore` +- Node.js 24 or newer + +## 1. Create a Prisma Postgres database + +Create a Prisma Postgres database from Console or with the CLI. Copy the direct connection string; you will use it for the restore and for `DATABASE_URL`. + +## 2. Export from PostgreSQL + +Run `pg_dump` against the source database: + +```shell +pg_dump -Fc -v -d "postgresql://USER:PASSWORD@HOST:PORT/DATABASE" -n public -f db_dump.bak +``` + +## 3. Restore into Prisma Postgres + +Restore the dump with the direct Prisma Postgres connection string: + +```shell +pg_restore -d "postgres://USER:PASSWORD@db.prisma.io:5432/postgres?sslmode=require" -v ./db_dump.bak +``` + +## 4. Add Prisma Next + +From your app root, initialize Prisma Next: + +```npm +npx prisma-next init +``` + +Choose PostgreSQL, set `DATABASE_URL` to the Prisma Postgres connection string, then infer and emit the contract: + +```npm +npx prisma-next contract infer --output ./prisma/contract.prisma +npx prisma-next contract emit +npx prisma-next db sign +``` + +## Next steps + +- Review the inferred contract before you rely on it in application code. +- Use the [PostgreSQL existing-project guide](/next/add-to-existing-project/postgresql) for the first Prisma Next query. +- Use the [full Prisma Postgres import guide](/prisma-postgres/import-from-existing-database-postgresql) for deeper migration details. diff --git a/apps/docs/content/docs/(index)/next/prisma-postgres/meta.json b/apps/docs/content/docs/(index)/next/prisma-postgres/meta.json new file mode 100644 index 0000000000..42fcedfea9 --- /dev/null +++ b/apps/docs/content/docs/(index)/next/prisma-postgres/meta.json @@ -0,0 +1,8 @@ +{ + "title": "Prisma Postgres", + "pages": [ + "import-from-existing-database-postgresql", + "import-from-existing-database-mysql", + "from-the-cli" + ] +} diff --git a/apps/docs/content/docs/(index)/next/quickstart/meta.json b/apps/docs/content/docs/(index)/next/quickstart/meta.json new file mode 100644 index 0000000000..3a7edc76ec --- /dev/null +++ b/apps/docs/content/docs/(index)/next/quickstart/meta.json @@ -0,0 +1,4 @@ +{ + "title": "Quickstart", + "pages": ["postgresql", "mongodb"] +} diff --git a/apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx b/apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx new file mode 100644 index 0000000000..8ee6aba84b --- /dev/null +++ b/apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx @@ -0,0 +1,89 @@ +--- +title: MongoDB +description: Create a new Prisma Next project with MongoDB using create-prisma@next. +url: /next/quickstart/mongodb +metaTitle: 'Quickstart: Prisma Next with MongoDB' +metaDescription: Scaffold a Prisma Next project with MongoDB, apply the starter migration, seed data, and run your first query. +--- + +Create a Prisma Next app with MongoDB, seed it, and run your first query. + +:::note[Prisma Next is in Early Access] + +Prisma Next is the next major version of Prisma ORM, available now in Early Access. It’s the cutting-edge version of Prisma ORM and will become the future of Prisma, so we’d love for you to try it, explore what’s new, and [share your feedback in Discord](https://pris.ly/discord). + +If you want to stay on the current generally available version of Prisma ORM, you can continue with [Prisma 7](/getting-started). + +::: + +## Quick start + +```npm +npx create-prisma@next --provider mongodb +``` + +Run this from a Node.js 24 or newer environment. The command preselects MongoDB. The generated local setup gives you a MongoDB replica set through `db:up`; if you use MongoDB Atlas or another existing deployment, set `DATABASE_URL` and skip `db:up`. + +Setup gives you the app template, a starter contract, `prisma-next.md`, project-level Prisma Next skills for your coding agent, and package scripts for the database steps below. + +For local development, use a replica set. MongoDB Atlas already provides one, and the generated `db:up` script starts one for you. + +## 1. Check the database connection + +Open `.env` and confirm that `DATABASE_URL` points to the MongoDB deployment you want Prisma Next to use. + +```text title=".env" +DATABASE_URL="mongodb://127.0.0.1:27017/app?replicaSet=rs0" +``` + +If you use MongoDB Atlas, replace this with the connection string from your Atlas cluster. + +## 2. Start MongoDB + +From the generated project directory, run `db:up` to start the local replica set. + +```npm +npm run db:up +``` + +Skip this command when you use MongoDB Atlas or another existing deployment. + +## 3. Create the migration plan + +Create the first migration plan from the starter contract. + +```npm +npm run migration:plan -- --name init +``` + +## 4. Apply the migration + +Apply the planned migration to MongoDB. + +```npm +npm run migrate +``` + +## 5. Seed data + +`db:seed` inserts sample users so the first query has data to show. + +```npm +npm run db:seed +``` + +## 6. Run the app + +Start the app and confirm the sample query runs successfully. + +```npm +npm run dev +``` + +Use the URL or terminal output shown by your template. You should see the seeded users returned from MongoDB. + +## Next steps + +- Open `src/prisma/contract.prisma` or `src/prisma/contract.ts` and change the starter model. +- Use the [MongoDB existing-project guide](/next/add-to-existing-project/mongodb) if you already have an app and database. +- Read the [Prisma Next overview](/orm/next) when you want the concepts behind contracts, query APIs, and migrations. diff --git a/apps/docs/content/docs/(index)/next/quickstart/postgresql.mdx b/apps/docs/content/docs/(index)/next/quickstart/postgresql.mdx new file mode 100644 index 0000000000..213a39b6bc --- /dev/null +++ b/apps/docs/content/docs/(index)/next/quickstart/postgresql.mdx @@ -0,0 +1,71 @@ +--- +title: PostgreSQL +description: Create a new Prisma Next project with PostgreSQL using create-prisma@next. +url: /next/quickstart/postgresql +metaTitle: 'Quickstart: Prisma Next with PostgreSQL' +metaDescription: Scaffold a Prisma Next project with PostgreSQL, initialize the database, seed data, and run your first query. +--- + +Create a Prisma Next app with PostgreSQL, seed it, and run your first query. + +:::note[Prisma Next is in Early Access] + +Prisma Next is the next major version of Prisma ORM, available now in Early Access. It’s the cutting-edge version of Prisma ORM and will become the future of Prisma, so we’d love for you to try it, explore what’s new, and [share your feedback in Discord](https://pris.ly/discord). + +If you want to stay on the current generally available version of Prisma ORM, you can continue with [Prisma 7](/getting-started). + +::: + +## Quick start + +```npm +npx create-prisma@next --provider postgres +``` + +Run this from a Node.js 24 or newer environment. The command preselects PostgreSQL, so you can focus on the template and database URL prompts. Pick Prisma Postgres if you want setup to create the database for you, or paste your own `DATABASE_URL`. + +Setup gives you the app template, a starter contract, `prisma-next.md`, project-level Prisma Next skills for your coding agent, and package scripts for the database steps below. + +If you use your own database, keep the connection string ready before you start. + +## 1. Check the database connection + +Open `.env` and confirm that `DATABASE_URL` points to the PostgreSQL database you want Prisma Next to use. + +```text title=".env" +DATABASE_URL="postgresql://username:password@host:5432/database?sslmode=require" +``` + +If you chose Prisma Postgres during setup, this value is already written for you. If you pasted your own connection string, keep it in `.env` and do not hardcode it in application code. + +## 2. Initialize the database + +From the generated project directory, run `db:init` to apply the starter schema to PostgreSQL and sign the database. + +```npm +npm run db:init +``` + +## 3. Seed data + +`db:seed` inserts sample users so the first query has data to show. + +```npm +npm run db:seed +``` + +## 4. Run the app + +Start the app and confirm the sample query runs successfully. + +```npm +npm run dev +``` + +Use the URL or terminal output shown by your template. You should see the seeded users returned from PostgreSQL. + +## Next steps + +- Open `src/prisma/contract.prisma` or `src/prisma/contract.ts` and change the starter model. +- Use the [PostgreSQL existing-project guide](/next/add-to-existing-project/postgresql) if you already have an app and database. +- Read the [Prisma Next overview](/orm/next) when you want the concepts behind contracts, query APIs, and migrations. diff --git a/apps/docs/content/docs/(index)/prisma-postgres/quickstart/meta.json b/apps/docs/content/docs/(index)/prisma-postgres/quickstart/meta.json index bbfa7c4d52..36716edce9 100644 --- a/apps/docs/content/docs/(index)/prisma-postgres/quickstart/meta.json +++ b/apps/docs/content/docs/(index)/prisma-postgres/quickstart/meta.json @@ -1,4 +1,4 @@ { "title": "Quickstart", - "pages": ["prisma-orm", "kysely", "drizzle-orm", "typeorm"] + "pages": ["prisma-next", "prisma-orm", "kysely", "drizzle-orm", "typeorm"] } diff --git a/apps/docs/content/docs/(index)/prisma-postgres/quickstart/prisma-next.mdx b/apps/docs/content/docs/(index)/prisma-postgres/quickstart/prisma-next.mdx new file mode 100644 index 0000000000..1bfbeedaaa --- /dev/null +++ b/apps/docs/content/docs/(index)/prisma-postgres/quickstart/prisma-next.mdx @@ -0,0 +1,56 @@ +--- +title: Prisma Next +description: Create a Prisma Next app with Prisma Postgres. +url: /prisma-postgres/quickstart/prisma-next +metaTitle: 'Quickstart: Prisma Next with Prisma Postgres' +metaDescription: Create a Prisma Next app, provision Prisma Postgres, seed data, and run your first query. +badge: early-access +--- + +Create a Prisma Next app backed by Prisma Postgres. + +## Quick start + +```npm +npx create-prisma@next +``` + +Run this from a Node.js 24 or newer environment. When prompted, choose PostgreSQL and Prisma Postgres. + +Setup provisions the database, writes `DATABASE_URL`, adds a starter contract, creates `prisma-next.md`, installs project-level Prisma Next skills for your coding agent, and adds package scripts for the database steps below. + +## 1. Create the app + +Run `create-prisma@next` and choose the minimal template if you want the fastest first run. Choose a framework template when you want the first query wired into an app route or page. + +## 2. Initialize the database + +From the generated project directory, run `db:init` to apply the starter schema to Prisma Postgres and sign the database. + +```npm +npm run db:init +``` + +## 3. Seed data + +`db:seed` inserts sample data so the first query returns something immediately. + +```npm +npm run db:seed +``` + +## 4. Run the app + +Start the app and confirm the sample query runs successfully. + +```npm +npm run dev +``` + +Use the URL or terminal output shown by your template to confirm the sample query runs successfully. + +## Next steps + +- Open the generated contract and change the starter model. +- Use [Import from PostgreSQL](/next/prisma-postgres/import-from-existing-database-postgresql) or [Import from MySQL](/next/prisma-postgres/import-from-existing-database-mysql) when you want to move an existing database to Prisma Postgres. +- Use the [PostgreSQL existing-project guide](/next/add-to-existing-project/postgresql) when your app already has a Prisma Postgres database. diff --git a/apps/docs/content/docs/cli/meta.json b/apps/docs/content/docs/cli/meta.json index 648b580a5d..e95c2953ad 100644 --- a/apps/docs/content/docs/cli/meta.json +++ b/apps/docs/content/docs/cli/meta.json @@ -6,6 +6,7 @@ "pages": [ "---Introduction---", "index", + "next", "---Standalone commands---", "init", diff --git a/apps/docs/content/docs/cli/next/configuration.mdx b/apps/docs/content/docs/cli/next/configuration.mdx new file mode 100644 index 0000000000..2559fb493f --- /dev/null +++ b/apps/docs/content/docs/cli/next/configuration.mdx @@ -0,0 +1,91 @@ +--- +title: CLI configuration +description: Configure Prisma Next CLI commands with prisma-next.config.ts and global flags. +url: /cli/next/configuration +metaTitle: Prisma Next CLI configuration +metaDescription: Learn how Prisma Next CLI commands find config, read database URLs, and format output. +--- + +Prisma Next CLI commands use `prisma-next.config.ts` as the project entrypoint for contract emission, database operations, and migrations. + +## Config file + +Commands that need project context read the Prisma Next config from your project. For PostgreSQL projects, use the Postgres config helper: + +```typescript title="prisma-next.config.ts" +import "dotenv/config"; +import { defineConfig } from "@prisma-next/postgres/config"; + +export default defineConfig({ + contract: "./prisma/contract.prisma", + db: { + connection: process.env["DATABASE_URL"]!, + }, +}); +``` + +For MongoDB projects, import `defineConfig` from `@prisma-next/mongo/config` instead. + +Pass `--config` when your config file is not in the default project location: + +```bash +prisma-next contract emit --config ./config/prisma-next.config.ts +``` + +## Emit-only config + +`contract emit` does not connect to a database, so the config can omit `db.connection`: + +```typescript title="prisma-next.config.ts" +import { defineConfig } from "@prisma-next/postgres/config"; + +export default defineConfig({ + contract: "./prisma/contract.prisma", +}); +``` + +Add `db.connection` before running commands such as `db verify`, `db sign`, `db init`, `db update`, `db schema`, `contract infer`, or `migration apply`. + +## Extension packs + +Add extension control descriptors to the config when your contract uses extension-provided types: + +```typescript title="prisma-next.config.ts" +import { defineConfig } from "@prisma-next/postgres/config"; +import pgvector from "@prisma-next/extension-pgvector/control"; + +export default defineConfig({ + contract: "./prisma/contract.prisma", + extensions: [pgvector], + db: { + connection: process.env["DATABASE_URL"]!, + }, +}); +``` + +Re-run `prisma-next contract emit` after changing extension packs, then update the matching runtime client. + +## Database URLs + +Database commands accept `--db `. If you omit it, Prisma Next can use the database connection from `prisma-next.config.ts`. + +```bash +prisma-next db verify --db "$DATABASE_URL" +``` + +## Environment variables + +| Variable | What it does | +| --- | --- | +| `DATABASE_URL` | Common place to store the database connection string used by config files and scripts. | +| `NO_COLOR=1` | Disables colored terminal output. | + +## Output modes + +Use the default text output when running commands locally. Use `--json` in CI or automation: + +```bash +prisma-next db verify --db "$DATABASE_URL" --json +``` + +Use `--no-interactive` for scripts that must never pause for user input. diff --git a/apps/docs/content/docs/cli/next/contract-emit.mdx b/apps/docs/content/docs/cli/next/contract-emit.mdx new file mode 100644 index 0000000000..7991b19c5c --- /dev/null +++ b/apps/docs/content/docs/cli/next/contract-emit.mdx @@ -0,0 +1,52 @@ +--- +title: prisma-next contract emit +description: Emit Prisma Next contract artifacts. +url: /cli/next/contract-emit +metaTitle: prisma-next contract emit +metaDescription: Learn how to emit contract.json and contract.d.ts for Prisma Next. +--- + +`prisma-next contract emit` reads your contract source and writes the generated artifacts used by the runtime, verification, and migration tooling. + +The command is offline. It does not need a database connection. + +## Usage + +```bash +prisma-next contract emit +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--json` | Prints a machine-readable result. | +| `-q`, `--quiet` | Suppresses nonessential output. | +| `-v`, `--verbose` | Prints more detail. | + +## What it creates + +The command emits: + +- `contract.json`, the canonical machine-readable contract +- `contract.d.ts`, the generated TypeScript contract declarations + +Do not edit these files by hand. Re-run `contract emit` after changing the contract source or extension pack list. + +## Examples + +```bash +prisma-next contract emit +prisma-next contract emit --config ./custom-config.ts +prisma-next contract emit --json +``` + +## Next steps + +After emitting, choose the database workflow: + +- use [`prisma-next db init`](/cli/next/db-init) for first-time bootstrap +- use [`prisma-next db update`](/cli/next/db-update) for direct reconciliation +- use [`prisma-next migration plan`](/cli/next/migration-plan) for checked-in migrations +- use [`prisma-next db verify`](/cli/next/db-verify) to check drift diff --git a/apps/docs/content/docs/cli/next/contract-infer.mdx b/apps/docs/content/docs/cli/next/contract-infer.mdx new file mode 100644 index 0000000000..c4e80b446a --- /dev/null +++ b/apps/docs/content/docs/cli/next/contract-infer.mdx @@ -0,0 +1,54 @@ +--- +title: prisma-next contract infer +description: Infer a starter contract from an existing database. +url: /cli/next/contract-infer +metaTitle: prisma-next contract infer +metaDescription: Learn how to infer a Prisma Next PSL contract from a live database schema. +--- + +`prisma-next contract infer` inspects a live database and writes a starter PSL contract. + +Use it when you are adding Prisma Next to an existing database and want an initial contract to review and edit. + +## Usage + +```bash +prisma-next contract infer --db "$DATABASE_URL" +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--db ` | Connects to the database. | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--output ` | Writes the inferred PSL contract to a specific path. | +| `--json` | Prints a machine-readable result. | + +## Examples + +```bash +prisma-next contract infer --db "$DATABASE_URL" +prisma-next contract infer --db "$DATABASE_URL" --output ./prisma/contract.prisma +prisma-next contract infer --db "$DATABASE_URL" --json +``` + +## What to review + +Inference gives you a starting point, not a finished design. Review: + +- model and field names +- relation names +- mapped database names +- defaults, indexes, and constraints +- extension-backed column types + +Then run: + +```bash +prisma-next contract emit +prisma-next db sign --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" +``` + +`db sign` is the handoff point where you record that the existing database matches the reviewed contract. diff --git a/apps/docs/content/docs/cli/next/db-init.mdx b/apps/docs/content/docs/cli/next/db-init.mdx new file mode 100644 index 0000000000..0129b726fa --- /dev/null +++ b/apps/docs/content/docs/cli/next/db-init.mdx @@ -0,0 +1,52 @@ +--- +title: prisma-next db init +description: Initialize a database from the current Prisma Next contract. +url: /cli/next/db-init +metaTitle: prisma-next db init +metaDescription: Learn how to create missing database structures from a Prisma Next contract and sign the database. +--- + +`prisma-next db init` creates missing database structures from the current emitted contract and signs the database. + +Use it for first setup of a database that should match your current contract. + +## Usage + +```bash +prisma-next db init --db "$DATABASE_URL" +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--db ` | Connects to the database. | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--dry-run` | Shows planned operations without applying them. | +| `--json` | Prints a machine-readable result. | + +## Behavior + +`db init` is intended for bootstrap work. It creates missing structures needed by the contract and writes the contract marker after the database matches. + +Run a dry run first when you are not working with a disposable local database: + +```bash +prisma-next db init --db "$DATABASE_URL" --dry-run +``` + +## Examples + +```bash +prisma-next contract emit +prisma-next db init --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" +``` + +```bash +prisma-next db init --db "$DATABASE_URL" --dry-run --json +``` + +## When to use db update instead + +Use [`prisma-next db update`](/cli/next/db-update) when the database already exists and you want Prisma Next to reconcile it with a changed contract. Use [`prisma-next migration plan`](/cli/next/migration-plan) when you want a reviewable migration package in version control. diff --git a/apps/docs/content/docs/cli/next/db-schema.mdx b/apps/docs/content/docs/cli/next/db-schema.mdx new file mode 100644 index 0000000000..668f5fc4cd --- /dev/null +++ b/apps/docs/content/docs/cli/next/db-schema.mdx @@ -0,0 +1,36 @@ +--- +title: prisma-next db schema +description: Inspect a live database schema. +url: /cli/next/db-schema +metaTitle: prisma-next db schema +metaDescription: Learn how to inspect a live database schema with Prisma Next. +--- + +`prisma-next db schema` reads the live database schema and prints it. The command is read-only. + +Use it when you need to inspect what Prisma Next sees in the database before inferring, signing, updating, or debugging drift. + +## Usage + +```bash +prisma-next db schema --db "$DATABASE_URL" +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--db ` | Connects to the database. | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--json` | Prints machine-readable schema output. | + +## Examples + +```bash +prisma-next db schema --db "$DATABASE_URL" +prisma-next db schema --db "$DATABASE_URL" --json > schema.json +``` + +## Related commands + +Use [`prisma-next contract infer`](/cli/next/contract-infer) when you want to turn a live schema into a starter PSL contract. Use [`prisma-next db verify`](/cli/next/db-verify) when you want to compare the live schema with the emitted contract. diff --git a/apps/docs/content/docs/cli/next/db-sign.mdx b/apps/docs/content/docs/cli/next/db-sign.mdx new file mode 100644 index 0000000000..7e265dcdc2 --- /dev/null +++ b/apps/docs/content/docs/cli/next/db-sign.mdx @@ -0,0 +1,43 @@ +--- +title: prisma-next db sign +description: Sign a database with the current Prisma Next contract. +url: /cli/next/db-sign +metaTitle: prisma-next db sign +metaDescription: Learn how to sign a database once it matches the current Prisma Next contract. +--- + +`prisma-next db sign` verifies that the live database satisfies the emitted contract and writes the database signature. + +Use it after importing or inferring an existing schema, or after a deployment flow that already applied the required database changes. + +## Usage + +```bash +prisma-next db sign --db "$DATABASE_URL" +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--db ` | Connects to the database. | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--json` | Prints a machine-readable result. | + +## Example + +```bash +prisma-next contract emit +prisma-next db sign --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" +``` + +## When to use it + +Use `db sign` only after you believe the live database already matches the emitted contract. It is common after: + +- `contract infer` for a brownfield database +- a manually reviewed migration flow +- a database restore that you need to mark as matching the current contract + +Do not use `db sign` to hide drift. If verification fails, fix the contract or database first. diff --git a/apps/docs/content/docs/cli/next/db-update.mdx b/apps/docs/content/docs/cli/next/db-update.mdx new file mode 100644 index 0000000000..68d622f3f6 --- /dev/null +++ b/apps/docs/content/docs/cli/next/db-update.mdx @@ -0,0 +1,44 @@ +--- +title: prisma-next db update +description: Update a database to match the current Prisma Next contract. +url: /cli/next/db-update +metaTitle: prisma-next db update +metaDescription: Learn how to reconcile a database with the current Prisma Next contract. +--- + +`prisma-next db update` compares the live database with the emitted contract and applies the required changes. + +Use it for direct reconciliation when you do not need a checked-in migration package. + +## Usage + +```bash +prisma-next db update --db "$DATABASE_URL" +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--db ` | Connects to the database. | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--dry-run` | Shows planned operations without applying them. | +| `-y`, `--yes` | Confirms prompts where the command supports confirmation. | +| `--json` | Prints a machine-readable result. | + +## Recommended flow + +```bash +prisma-next contract emit +prisma-next db update --db "$DATABASE_URL" --dry-run +prisma-next db update --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" +``` + +Use `--dry-run` before applying changes in shared environments. + +## When to use migrations instead + +For reviewable database changes in version control, use [`prisma-next migration plan`](/cli/next/migration-plan) and [`prisma-next migration apply`](/cli/next/migration-apply). + +Use `db update` for local development, preview environments, and workflows where direct reconciliation is acceptable. diff --git a/apps/docs/content/docs/cli/next/db-verify.mdx b/apps/docs/content/docs/cli/next/db-verify.mdx new file mode 100644 index 0000000000..dca6a1d1ed --- /dev/null +++ b/apps/docs/content/docs/cli/next/db-verify.mdx @@ -0,0 +1,54 @@ +--- +title: prisma-next db verify +description: Verify a database against the current Prisma Next contract. +url: /cli/next/db-verify +metaTitle: prisma-next db verify +metaDescription: Learn how to verify that a database marker and live schema match the Prisma Next contract. +--- + +`prisma-next db verify` checks whether the database marker and live schema match your emitted contract. + +Use it in CI and deployment checks before application code that depends on a contract reaches users. + +## Usage + +```bash +prisma-next db verify --db "$DATABASE_URL" +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--db ` | Connects to the database. | +| `--config ` | Reads a specific `prisma-next.config.ts` file. | +| `--marker-only` | Checks only the database marker. | +| `--schema-only` | Checks only whether the live schema satisfies the contract. | +| `--strict` | Fails if the database includes schema elements not present in the contract. | +| `--json` | Prints machine-readable output. | + +## Examples + +```bash +prisma-next db verify --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" --strict +prisma-next db verify --db "$DATABASE_URL" --schema-only +prisma-next db verify --db "$DATABASE_URL" --marker-only +``` + +Use JSON output in automation: + +```bash +prisma-next db verify --db "$DATABASE_URL" --json +``` + +## What failures mean + +| Failure | Meaning | +| --- | --- | +| Marker mismatch | The database was not signed for the emitted contract, or the contract changed after signing. | +| Schema mismatch | The live database does not satisfy the emitted contract. | +| Strict mismatch | The database has extra schema elements not present in the contract. | +| Extension mismatch | The contract requires an extension that is not wired in the config. | + +Fix the database or contract, emit again if needed, then verify again. diff --git a/apps/docs/content/docs/cli/next/index.mdx b/apps/docs/content/docs/cli/next/index.mdx new file mode 100644 index 0000000000..e4707f78b4 --- /dev/null +++ b/apps/docs/content/docs/cli/next/index.mdx @@ -0,0 +1,99 @@ +--- +title: Prisma Next CLI +description: Reference for the Prisma Next command line interface. +url: /cli/next +metaTitle: Prisma Next CLI reference +metaDescription: Learn the Prisma Next CLI commands for contracts, databases, and migrations. +badge: early-access +--- + +The Prisma Next CLI is exposed as `prisma-next`. It reads your `prisma-next.config.ts`, emits contract artifacts, verifies databases, and manages Prisma Next migrations. + +:::note[Prisma Next is in Early Access] + +Prisma Next is the next major version of Prisma ORM, available now in Early Access. It’s the cutting-edge version of Prisma ORM and will become the future of Prisma, so we’d love for you to try it, explore what’s new, and [share your feedback in Discord](https://pris.ly/discord). + +If you want to stay on the current generally available version of Prisma ORM, you can continue with [Prisma 7](/getting-started). + +::: + +Install the CLI package in a Prisma Next project: + +```bash +npm install -D prisma-next +``` + +Then run commands with your package manager: + +```bash +npx prisma-next help +npx prisma-next contract emit +``` + +For a full app scaffold, use a [Prisma Next quickstart](/next/quickstart/postgresql). That path creates the project files and package scripts for you. This CLI reference is for the lower-level commands those scripts call. + +## Common workflows + +Start an existing project: + +```bash +prisma-next init --target postgres --authoring psl +prisma-next contract emit +prisma-next db init --db "$DATABASE_URL" +``` + +Adopt an existing database: + +```bash +prisma-next contract infer --db "$DATABASE_URL" --output ./prisma/contract.prisma +prisma-next contract emit +prisma-next db sign --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" +``` + +Use checked-in migrations: + +```bash +prisma-next contract emit +prisma-next migration plan --name add-users +prisma-next migration status --db "$DATABASE_URL" +prisma-next migration apply --db "$DATABASE_URL" +prisma-next db verify --db "$DATABASE_URL" +``` + +## Command groups + +| Command | Purpose | +| --- | --- | +| [`prisma-next init`](/cli/next/init) | Add Prisma Next files to a project. | +| [`prisma-next contract emit`](/cli/next/contract-emit) | Emit `contract.json` and `contract.d.ts` from your contract source. | +| [`prisma-next contract infer`](/cli/next/contract-infer) | Infer a starter PSL contract from an existing database. | +| [`prisma-next db init`](/cli/next/db-init) | Create missing database structures from the current contract and sign the database. | +| [`prisma-next db update`](/cli/next/db-update) | Reconcile an existing database with the current contract. | +| [`prisma-next db schema`](/cli/next/db-schema) | Inspect the live database schema. | +| [`prisma-next db sign`](/cli/next/db-sign) | Record that a database matches the current contract. | +| [`prisma-next db verify`](/cli/next/db-verify) | Check that a database still matches the current contract. | +| [`prisma-next migration plan`](/cli/next/migration-plan) | Create an on-disk migration package from contract changes. | +| [`prisma-next migration new`](/cli/next/migration-new) | Scaffold a migration package for manual authoring. | +| [`prisma-next migration apply`](/cli/next/migration-apply) | Apply pending on-disk migrations. | +| [`prisma-next migration status`](/cli/next/migration-status) | Show migration history and applied state. | +| [`prisma-next migration show`](/cli/next/migration-show) | Inspect a migration package. | +| [`prisma-next migration ref`](/cli/next/migration-ref) | Manage named migration refs. | + +## Global flags + +Most Prisma Next commands accept these flags. + +| Flag | What it does | +| --- | --- | +| `--json` | Print machine-readable output. Use this in CI and scripts. | +| `-q`, `--quiet` | Suppress nonessential output. | +| `-v`, `--verbose` | Print more detail. | +| `--trace` | Include stack traces for failures. | +| `--color` | Force colored output. | +| `--no-color` | Disable colored output. | +| `--interactive` | Allow prompts. | +| `--no-interactive` | Disable prompts. | +| `-y`, `--yes` | Accept prompts where the command supports confirmation. | + +Use `prisma-next --help` when you need the exact command help from the installed preview version. diff --git a/apps/docs/content/docs/cli/next/init.mdx b/apps/docs/content/docs/cli/next/init.mdx new file mode 100644 index 0000000000..66db8e2de1 --- /dev/null +++ b/apps/docs/content/docs/cli/next/init.mdx @@ -0,0 +1,69 @@ +--- +title: prisma-next init +description: Initialize Prisma Next files in a project. +url: /cli/next/init +metaTitle: prisma-next init +metaDescription: Learn how to initialize Prisma Next files in an existing project. +--- + +`prisma-next init` scaffolds the Prisma Next config, contract source, and runtime files inside an existing project. + +Use a [Prisma Next quickstart](/next/quickstart/postgresql) when you want a complete new application template. Use `prisma-next init` when you already have a project and want to add the lower-level Prisma Next files. + +## Usage + +```bash +prisma-next init +``` + +Run it non-interactively: + +```bash +prisma-next init --yes --target postgres --authoring psl +``` + +## Options + +| Option | What it does | +| --- | --- | +| `--target ` | Sets the database target. Use `postgres` or `mongodb`. | +| `--authoring