Feat: DC-5299 migrate "connecting-to-postgresql-databases"

[carlagn]

Fixes #DC-5299

Summary by CodeRabbit

• Documentation
  • Added “Connecting to PostgreSQL databases” guide for using psql.
  • Covers local vs. remote connections, Unix socket vs. host/port, and required parameters (host, port, user, password, database).
  • Shows both command-line options and connection string formats with examples.
  • Explains peer authentication, sudo access to the postgres user, and password prompts.
  • Includes links to related authentication configuration, URI format references, and troubleshooting tips.

[github-actions]

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

[github-actions]

original	preview
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx	content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx

[github-actions]

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

• This PR does not change any pages in a way that would require a redirect.

[cloudflare-workers-and-pages]

Deploying docs with    Cloudflare Pages

Latest commit:	d32e72a
Status:	✅  Deploy successful!
Preview URL:	https://87c24f94.docs-51g.pages.dev
Branch Preview URL:	https://feat-dc-5299-dataguide-migra.docs-51g.pages.dev

View logs

[coderabbitai]

Walkthrough

Adds a new MDX documentation page “Connecting to PostgreSQL databases,” detailing how to connect with psql using local sockets and remote TCP, command-line options and connection strings, authentication behaviors (peer, sudo for postgres), example parameters, password prompting, and links to related authentication and URI format guides.

Changes

Cohort / File(s)	Summary of changes
Docs: PostgreSQL connection guide content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx	New MDX page explaining psql connections (local vs. remote), option flags vs. connection strings, authentication methods, examples, and references to related docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly references the key change—migrating the “connecting-to-postgresql-databases” documentation—and ties it to the related issue ID without extraneous detail, making it clear and focused.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 207cce9 and d32e72a.

📒 Files selected for processing (1)

• content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx

[grammar] ~12-~12: There might be a mistake here.
Context: ...g the native psql command line client — one of the most common and useful ways of i...

(QB_NEW_EN)

---

[grammar] ~20-~20: Use a hyphen to join words.
Context: ...t The psql client, the native command line client for PostgreSQL, can connect ...

(QB_NEW_EN_HYPHEN)

---

[style] ~20-~20: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...tting the basic configuration in place, prior to interacting with the database through a...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

---

[grammar] ~24-~24: There might be a mistake here.
Context: ... instance are located on the same server - remote connection: where the client is...

(QB_NEW_EN)

---

[style] ~43-~43: You have already used this phrasing in nearby sentences. Consider omitting or replacing it to add variety to your writing.
Context: ...s also created on the operating system. So, to log into PostgreSQL as the `postgres...

(REP_SENT_START_SO)

---

[grammar] ~88-~88: There might be a mistake here.
Context: ...he following requirements: - hostname: myhost - port: 1234 - database: applicationdb -...

(QB_NEW_EN)

---

[grammar] ~89-~89: There might be a mistake here.
Context: ...ents: - hostname: myhost - port: 1234 - database: applicationdb - username: `m...

(QB_NEW_EN)

---

[grammar] ~90-~90: There might be a mistake here.
Context: ...name: myhost - port: 1234 - database: applicationdb - username: myapplicationuser - password...

(QB_NEW_EN)

---

[grammar] ~91-~91: There might be a mistake here.
Context: ...- database: applicationdb - username: myapplicationuser - password: mypass Calling psql with ...

(QB_NEW_EN)

---

[grammar] ~128-~128: Use a hyphen to join words.
Context: ...monstrated how to use the psql command line client to connect to both local and...

(QB_NEW_EN_HYPHEN)

---

[style] ~128-~128: Consider using a more concise synonym.
Context: ...cal and remote database instances using a variety of methods. Knowing how to connect to var...

(A_VARIETY_OF)

⏰ 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). (2)

• GitHub Check: runner / linkspector
• GitHub Check: Check internal links

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b7c440 and bf81acf.

📒 Files selected for processing (2)

• content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx (1 hunks)
• content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Documentation Checks

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx

[error] 2-2: CSpell: Unknown word (Dataguide)

---

[error] 3-3: CSpell: Unknown word (Dataguide)

---

[error] 14-14: CSpell: Unknown word (Dataguide)

⏰ 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: Cloudflare Pages

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b7c440 and 0185850.

📒 Files selected for processing (3)

• content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx (1 hunks)
• content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
• content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Documentation Checks

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

[error] 44-44: Unknown word (BCNF)

---

[error] 45-45: Unknown word (multivalued)

---

[error] 137-137: Unknown word (BCNF)

---

[error] 138-138: Unknown word (BCNF)

---

[error] 138-138: Unknown word (Boyce)

---

[error] 138-138: Unknown word (Codd)

---

[error] 219-219: Unknown word (superkey)

---

[error] 693-693: Unknown word (HTAP)

---

[error] 694-694: Unknown word (HTAP)

---

[error] 900-900: Unknown word (Multiversion)

---

[error] 901-901: Unknown word (Multiversion)

---

[error] 901-901: Unknown word (MVCC)

---

[error] 903-903: Unknown word (MVCC)

---

[error] 904-904: Unknown word (MVCC)

---

[error] 961-961: Unknown word (Nonrepeatable)

---

[error] 962-962: Unknown word (nonrepeatable)

---

[error] 963-963: Unknown word (nonrepeatable)

---

[error] 978-978: Unknown word (OLAP)

---

[error] 979-979: Unknown word (OLAP)

---

[error] 981-981: Unknown word (OLAP)

---

[error] 987-987: Unknown word (OLTP)

---

[error] 988-988: Unknown word (OLTP)

---

[error] 990-990: Unknown word (OLTP)

---

[error] 992-992: Unknown word (OLTP)

---

[error] 1160-1160: Unknown word (Nonrepeatable)

---

[error] 1183-1183: Unknown word (nonrepeatable)

---

[error] 1221-1221: Unknown word (RDBMS)

---

[error] 1222-1222: Unknown word (RDBMS)

---

[error] 1224-1224: Unknown word (RDBMS)

---

[error] 1230-1230: Unknown word (nonrepeatable)

---

[error] 1346-1346: Unknown word (Nonrepeatable)

---

[error] 1431-1431: Unknown word (Superkey)

---

[error] 1432-1432: Unknown word (superkey)

---

[error] 1435-1435: Unknown word (superkey)

---

[error] 1436-1436: Unknown word (superkey)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx

[error] 2-2: Unknown word (Dataguide)

---

[error] 3-3: Unknown word (Dataguide)

---

[error] 14-14: Unknown word (Dataguide)

⏰ 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). (2)

• GitHub Check: runner / linkspector
• GitHub Check: Check internal links

🔇 Additional comments (2)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1)

43-50: Resolve spellcheck pipeline failures.

The docs lint is failing on domain-specific terms (BCNF, multivalued, MVCC, HTAP, nonrepeatable, OLAP, OLTP, RDBMS, superkey, etc.). Please add these to the shared spelling dictionary (for example, the cspell wordlist) so the pipeline passes.

Also applies to: 137-145, 693-705, 900-911, 961-969, 978-1002, 1221-1234, 1344-1437

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1)

2-16: Resolve “Dataguide” spelling lint.

Docs checks flag “Dataguide” as an unknown word. Either switch to the house style (e.g., “Data Guide”) or add “Dataguide” to the shared dictionary alongside the glossary terms so CI passes.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cdf2094 and 1dcb3c3.

📒 Files selected for processing (2)

• src/theme/DocCard/index.tsx (1 hunks)
• src/theme/DocCard/styles.module.scss (1 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). (2)

• GitHub Check: Check internal links
• GitHub Check: runner / linkspector

🔇 Additional comments (1)

src/theme/DocCard/styles.module.scss (1)

43-46: LGTM!

The new .cardDescription class with max-width: 100%; is a standard approach to ensure the description element doesn't overflow its container.