Add how-to guide for connecting to PostgreSQL via psql (#188)
## Summary - Add new how-to guide (`connect-to-postgres.md`) with the `psql` command using `op read` for 1Password credentials - Add "Database" section to the how-to index linking to the new guide - Link the new guide from the PostgreSQL reference card's Related section ## Test plan - [x] Verified `psql` connection works from gilbert using the documented command - [ ] Review doc formatting and content 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/188
This commit is contained in:
parent
49ec05041c
commit
eec1edf43d
4 changed files with 57 additions and 0 deletions
1
docs/changelog.d/docs-connect-to-postgres.doc.md
Normal file
1
docs/changelog.d/docs-connect-to-postgres.doc.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Add how-to guide for connecting to PostgreSQL as a superuser via psql.
|
||||
49
docs/how-to/connect-to-postgres.md
Normal file
49
docs/how-to/connect-to-postgres.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: Connect to Postgres
|
||||
modified: 2026-02-14
|
||||
tags:
|
||||
- how-to
|
||||
- database
|
||||
---
|
||||
|
||||
# Connect to Postgres
|
||||
|
||||
How to connect to the [[postgresql]] cluster as a superuser using `psql`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- `psql` installed (`brew install libpq` on macOS)
|
||||
- [1Password CLI](https://developer.1password.com/docs/cli/) (`op`) installed and signed in
|
||||
- Machine on the tailnet (e.g. [[gilbert]])
|
||||
|
||||
## Connect
|
||||
|
||||
```bash
|
||||
PGPASSWORD=$(op read "op://blumeops/postgres/password") psql -h pg.ops.eblu.me -U eblume -d postgres
|
||||
```
|
||||
|
||||
This connects as the `eblume` superuser. To connect to a specific database, replace `postgres` with the database name (e.g. `miniflux`, `teslamate`).
|
||||
|
||||
## Useful Queries
|
||||
|
||||
```sql
|
||||
-- List databases
|
||||
\l
|
||||
|
||||
-- List roles
|
||||
\du
|
||||
|
||||
-- Check cluster status (CNPG)
|
||||
SELECT pg_is_in_recovery();
|
||||
|
||||
-- Show active connections
|
||||
SELECT datname, usename, client_addr, state
|
||||
FROM pg_stat_activity
|
||||
WHERE state IS NOT NULL;
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
- [[postgresql]] - Service reference
|
||||
- [[borgmatic]] - Database backup
|
||||
- [[troubleshooting]] - Cluster health checks
|
||||
|
|
@ -38,6 +38,12 @@ Task-oriented instructions for common BlumeOps operations. These guides assume y
|
|||
|-------|-------------|
|
||||
| [[review-documentation]] | Periodically review and maintain documentation |
|
||||
|
||||
## Database
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [[connect-to-postgres]] | Connect to PostgreSQL as a superuser via psql |
|
||||
|
||||
## Operations
|
||||
|
||||
| Guide | Description |
|
||||
|
|
|
|||
|
|
@ -55,6 +55,7 @@ Backed up via [[borgmatic]] `postgresql_databases` hook. Streams `pg_dump` direc
|
|||
|
||||
## Related
|
||||
|
||||
- [[connect-to-postgres]] - How to connect via psql
|
||||
- [[miniflux]] - Feed reader database
|
||||
- [[teslamate]] - Vehicle data database
|
||||
- [[borgmatic]] - Database backup
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue