Skip to content

docs: add PostgreSQL coverage to installation page#173

Open
dimitri-yatsenko wants to merge 1 commit into
mainfrom
docs/installation-postgres
Open

docs: add PostgreSQL coverage to installation page#173
dimitri-yatsenko wants to merge 1 commit into
mainfrom
docs/installation-postgres

Conversation

@dimitri-yatsenko
Copy link
Copy Markdown
Member

Summary

  • Documents the datajoint[postgres] extra and the PostgreSQL Docker setup so the Installation how-to matches multi-backend support, not just MySQL.
  • Reframes the page from "MySQL-compatible" to MySQL/PostgreSQL as peer backends, and expands the cloud-database list (RDS, Cloud SQL, Azure Database) to include PostgreSQL.
  • Adds version notes: PostgreSQL backend introduced in 2.1, database.name setting introduced in 2.2.1. Adds a psycopg2 troubleshooting subsection and a pointer to configure-database.md#postgresql-backend for the full reference.

Test plan

  • mkdocs serve and open /how-to/installation/ — confirm both Docker snippets render, the datajoint[postgres] extra is visible, cloud DB list shows PostgreSQL, and the psycopg2 troubleshooting subsection appears.
  • Click the configure-database.md#postgresql-backend link and confirm it lands on the right anchor.
  • Re-read for peer framing — PostgreSQL should never be described as an "alternative" backend.

Bring the Installation how-to in line with multi-backend support:
- document the `datajoint[postgres]` extra (added in 2.1)
- replace "MySQL-compatible" with peer MySQL/PostgreSQL framing
- add a PostgreSQL Docker snippet beside the MySQL one
- list PostgreSQL options for RDS, Cloud SQL, and Azure Database
- add a psycopg2 troubleshooting subsection
- note PostgreSQL GRANT syntax differs, link to configure-database.md

Version notes call out 2.1 (initial PostgreSQL backend) and 2.2.1
(`database.name` setting for selecting a non-default PostgreSQL database).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant