improve docs around creating a foreign key constraint

Open
#150 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
postgresql
Domain
databases, documentation

Research direction

Start by locating the existing documentation for creating foreign key constraints and review the linked PostgreSQL migration articles. Update the relevant guidance to distinguish creating a new table from altering an existing table, including the safe migration considerations described in the references.

Written by the indexing model from the issue text.

Description

Also should note the differences between a new table, and adding to an existing table

https://gocardless.com/blog/zero-downtime-postgres-migrations-the-hard-parts/
https://medium.com/braintree-product-technology/postgresql-at-scale-database-schema-changes-without-downtime-20d3749ed680
https://travisofthenorth.com/blog/2017/2/2/postgres-adding-foreign-keys-with-zero-downtime

Dominant language
Rust
Stars
1.2k
Forks
70
Avg merge
52m
Merged PRs (30d)
47

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sbdchd/squawk

All issues in sbdchd/squawk

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.