move pages in ppg docs #7150
move pages in ppg docs #7150
Conversation
WalkthroughRedirects and in-doc links were updated to use /postgres/integrations/viewing-data (formerly /postgres/database/tooling); the tooling page frontmatter was renamed to "Viewing data". Direct-connections doc adds host/port customization details, fixes a typo, and adds security-considerations bullets. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
Comment |
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects: |
Deploying docs with
|
| Latest commit: |
0d3b5da
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d073e986.docs-51g.pages.dev |
| Branch Preview URL: | https://misc-ppg-structure.docs-51g.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx (4)
115-132: Port mismatch causes confusion (command uses 5432, sample output shows 52604).Either remove
--port 5432from the command or update the sample output to 5432. Recommend making them consistent at 5432.npx @prisma/ppg-tunnel --host 127.0.0.1 --port 5432 @@ -```cmd -Prisma Postgres auth proxy listening on 127.0.0.1:52604 🚀 +```cmd +Prisma Postgres auth proxy listening on 127.0.0.1:5432 🚀 @@ -hostname: 127.0.0.1 -port: 52604 +hostname: 127.0.0.1 +port: 5432 username: <anything> password: <none>Also applies to: 143-151 --- `166-166`: **Minor grammar (“already using”).** ```diff -If you already using Prisma ORM, the only things you need to do are: +If you are already using Prisma ORM, the only things you need to do are:
173-174: Typo (“Th Prisma”).-Th Prisma Accelerate extension is [required](/postgres/introduction/overview#using-the-client-extension-for-prisma-accelerate-required) when using Prisma Postgres. If you are not currently using Prisma Accelerate with Prisma ORM, go through the following steps to make Prisma ORM work with Prisma Postgres. +The Prisma Accelerate extension is [required](/postgres/introduction/overview#using-the-client-extension-for-prisma-accelerate-required) when using Prisma Postgres. If you are not currently using Prisma Accelerate with Prisma ORM, go through the following steps to make Prisma ORM work with Prisma Postgres.
200-201: Minor grammar (“assumes that you’re a .env”).-The next steps assumes that you're a `.env` file to set the `DATABASE_URL` environment variable (if that's not the case, you can set the environment variable in your preferred way). +The next steps assume that you're using a `.env` file to set the `DATABASE_URL` environment variable (if that's not the case, set the environment variable in your preferred way).content/100-getting-started/03-prisma-postgres/115-import-from-existing-database-mysql.mdx (2)
58-60: Direct connection snippet shows Accelerate URL; use postgres:// for “direct connection”.Step 1 instructs users to copy a
postgres://direct connection, but the snippet here showsprisma+postgres://(Accelerate). Align the example with a direct connection to avoid confusion.-```no-copy -prisma+postgres://accelerate.prisma-data.net/?api_key=ey... -``` +```no-copy +postgres://__USER__:__PASSWORD__@db.prisma.io:5432/?sslmode=require +```
176-186: Prisma schema provider must be "postgresql", not "postgres".Using
"postgres"will fail validation. Update the provider literal.- provider = "postgres" + provider = "postgresql"
🧹 Nitpick comments (3)
content/250-postgres/300-database/650-direct-connections.mdx (1)
179-179: Tighten phrasing and consider deep-linking.
- Style: prefer “third‑party”.
- Optional: Deep‑link directly to the specific editor subsections to reduce scrolling.
Possible tweak:
-The local tunnel enables you to access Prisma Postgres from 3rd party database editors such as Postico, DataGrip, TablePlus and pgAdmin. Learn more in this [section](/postgres/integrations/tooling). +The local tunnel enables you to access Prisma Postgres from third‑party database editors such as Postico, DataGrip, TablePlus, and pgAdmin. Learn more in this [section](/postgres/integrations/tooling) or jump to [TablePlus](/postgres/integrations/tooling#2a-connect-to-prisma-postgres-using-tableplus) and [DataGrip](/postgres/integrations/tooling#2b-connect-to-prisma-postgres-using-datagrip).Please confirm those anchors are correct post‑move.
content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx (2)
183-187: Add missing PrismaClient import in snippet.Without this, the snippet won’t compile.
-```ts -import { withAccelerate } from '@prisma/extension-accelerate' +```ts +import { PrismaClient } from '@prisma/client' +import { withAccelerate } from '@prisma/extension-accelerate' const prisma = new PrismaClient().$extends(withAccelerate())--- `208-214`: **Grammar and clarity.** Tighten phrasing and singularize “variable.” ```diff -As a last step, you need to re-generate Prisma Client for so that the updated environment variables takes effect and your queries go to Prisma Postgres going forward: +As a last step, re‑generate Prisma Client so that the updated environment variable takes effect and your queries go to Prisma Postgres:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx(1 hunks)content/100-getting-started/03-prisma-postgres/115-import-from-existing-database-mysql.mdx(1 hunks)content/250-postgres/300-database/650-direct-connections.mdx(2 hunks)static/_redirects(3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- static/_redirects
🔇 Additional comments (7)
content/250-postgres/300-database/650-direct-connections.mdx (1)
167-167: Fix typo, clarify auth behavior, and verify integration links-You can now connet to your Prisma Postgres editor using your favorite PostgreSQL client, e.g. `psql` or a GUI like [TablePlus](/postgres/integrations/tooling#2a-connect-to-prisma-postgres-using-tableplus) or [DataGrip](/postgres/integrations/tooling#2b-connect-to-prisma-postgres-using-datagrip). To do so, you only need to provide the **`host`** and **`port`** from the output above. The TCP tunnel will handle authentication via the API key in your Prisma Postgres connection URL, so you can omit the values for **`username`** and **`password`**. +You can now connect to your Prisma Postgres database using your favorite PostgreSQL client, e.g., `psql` or GUIs like [TablePlus](/postgres/integrations/tooling#2a-connect-to-prisma-postgres-using-tableplus) or [DataGrip](/postgres/integrations/tooling#2b-connect-to-prisma-postgres-using-datagrip). Provide the **`host`** and **`port`** from the output above. The TCP tunnel handles authentication via the API key in your Prisma Postgres connection URL, so you can leave **`username`** and **`password`** blank; if your client requires them, any values will work.Please confirm that the
/postgres/integrations/toolingpage and its anchors (#2a-connect-to-prisma-postgres-using-tableplus,#2b-connect-to-prisma-postgres-using-datagrip) are valid after the recent move.content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx (4)
103-105: Resolved: Confirmed the#tcp-tunnelanchor exists in the/postgres/database/direct-connectionspage under the ## TCP tunnel heading.
156-160: Anchor exists and no stale references remain: The anchor “viewing-and-editing-data-in-prisma-studio” is present in content/250-postgres/350-integrations/450-tooling.mdx, and there are no occurrences of the old/postgres/database/toolingpath.
21-21: Fix grammar (“during to run”).
Apply this diff:-In the third step, you will be using a [direct connection](/postgres/database/direct-connections) to securely connect to your Prisma Postgres database during to run `pg_restore`. +In the third step, you will use a [direct connection](/postgres/database/direct-connections) to securely connect to your Prisma Postgres database to run `pg_restore`.Confirmed
/postgres/database/direct-connectionsremains at content/250-postgres/300-database/650-direct-connections.mdx.
211-212: Confirm--no-engineflag support
The--no-engineflag is available in Prisma CLI from version 5.2.0 onward; ensure your project uses Prisma ≥ 5.2.0 to runnpx prisma generate --no-enginesuccessfully.content/100-getting-started/03-prisma-postgres/115-import-from-existing-database-mysql.mdx (2)
18-19: No updates required for direct-connections links. All references to/postgres/database/direct-connectionsremain valid and unchanged across the restructure—keep the URLs at lines 18–19 (and 54–56) as-is.
136-141: Link update LGTM: anchor verified and no old/postgres/database/toolingreferences remain.
content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx
Outdated
Show resolved
Hide resolved
…-existing-database-postgresql.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
static/_redirects (1)
545-638: Fix redirects to the renamed “Viewing data” page.
/postgres/toolingand the wildcard variant still redirect to/docs/postgres/integrations/tooling, which no longer exists after the rename, so users hit a 404. Point them straight to/docs/postgres/integrations/viewing-data(and cover the/docs/postgres/integrations/toolingpath) to avoid broken redirects.-/postgres/tooling /docs/postgres/integrations/tooling +/postgres/tooling /docs/postgres/integrations/viewing-data ... -/postgres/tooling* /docs/postgres/integrations/tooling +/postgres/tooling* /docs/postgres/integrations/viewing-data ... -/postgres/integrations/tooling /docs/postgres/integrations/viewing-data +/postgres/integrations/tooling /docs/postgres/integrations/viewing-data +/docs/postgres/integrations/tooling /docs/postgres/integrations/viewing-data
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx(1 hunks)content/100-getting-started/03-prisma-postgres/115-import-from-existing-database-mysql.mdx(1 hunks)content/250-postgres/300-database/650-direct-connections.mdx(2 hunks)static/_redirects(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: runner / linkspector
- GitHub Check: Check internal links
- GitHub Check: Lost Pixel
🔇 Additional comments (2)
content/100-getting-started/03-prisma-postgres/115-import-from-existing-database-mysql.mdx (1)
136-136: Thanks for aligning the Studio link.Updating the reference to the new
/postgres/integrations/viewing-datapath keeps this guide consistent with the renamed section.content/100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx (1)
156-156: Link update looks good.Pointing readers to the renamed “Viewing data” section keeps the validation step up to date.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/250-postgres/300-database/650-direct-connections.mdx (1)
21-21: Grammar: “an environment”.Minor edit.
-1. Navigate to a environment with an active Prisma Postgres instance +1. Navigate to an environment with an active Prisma Postgres instance
♻️ Duplicate comments (1)
content/250-postgres/300-database/650-direct-connections.mdx (1)
167-167: Links and copy look good; add explicit client examples for tunnel (sslmode=disable) and clarify username requirement.Nice fix and link updates; the “connect” typo is resolved. To prevent confusion with the earlier “SSL required” note for direct TCP (not via tunnel), please show explicit examples for the tunnel that set sslmode=disable and demonstrate a non-empty username some clients require.
Proposed insertion right after this paragraph:
+For psql, disable SSL when using the local tunnel and provide any non-empty username (password is not required): + +```bash +psql "postgresql://postgres@127.0.0.1:<PORT>/<DB_NAME>?sslmode=disable" +``` + +For GUI clients, set: +- Host: 127.0.0.1 +- Port: <PORT> +- SSL: disabled +- Username: any non-empty value (e.g., postgres) +- Password: leave emptyTo verify the anchors exist in the target page, run:
#!/bin/bash # Check that the anchors referenced here exist in the viewing-data doc fd -a 'viewing-data.mdx' content | while read f; do echo "File: $f" rg -n -i -C1 'Connect to Prisma Postgres using TablePlus|Connect to Prisma Postgres using DataGrip' "$f" done
🧹 Nitpick comments (1)
content/250-postgres/300-database/650-direct-connections.mdx (1)
179-179: “Next steps” link path is correct; minor copy polish.Consider hyphenating “third-party” and aligning capitalization.
-The local tunnel enables you to access Prisma Postgres from 3rd party database editors such as Postico, DataGrip, TablePlus and pgAdmin. Learn more in this [section](/postgres/integrations/viewing-data). +The local tunnel enables you to access Prisma Postgres from third‑party database editors such as Postico, DataGrip, TablePlus, and pgAdmin. Learn more in this [section](/postgres/integrations/viewing-data).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/250-postgres/300-database/650-direct-connections.mdx(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Check internal links
- GitHub Check: runner / linkspector
- GitHub Check: Lost Pixel
Summary by CodeRabbit
Bug Fixes
Documentation