Page MenuHomePhabricator

Core documentation docs/schema.md, docs/databases/postgres.txt and docs/databases/sqlite.txt seems out of date (after abstract schema work)
Closed, ResolvedPublic

Description

The doc files:

  • docs/schema.md
  • docs/databases/postgres.tx
  • docs/databases/sqlite.txt

are no longer up to date due to finish of the abstract schema work from T191231: RFC: Abstract schemas and schema changes and should be revisisted.

For example the sentence about sequences is no longer true and bytea is not so easy to support now (Some context under T257755#6863029)
Also foreign keys are no longer in use, CIDR is also removed

Event Timeline

Aklapper renamed this task from Core documenation docs/schema.md, docs/databases/postgres.txt and docs/databases/sqlite.txt seems out of date (after abstract schema work) to Core documentation docs/schema.md, docs/databases/postgres.txt and docs/databases/sqlite.txt seems out of date (after abstract schema work).Jul 26 2022, 9:38 PM

I think in our systems we have over-documentation issues sometimes and this is one of those. We are repeating same thing over and they are getting out of sync. My suggestion, remove most of them and point to https://www.mediawiki.org/wiki/Manual:Schema_changes

Most of these notes are codified into our abstract schema system so there is no need to document it again.

Change 826875 had a related patch set uploaded (by Ladsgroup; author: Amir Sarabadani):

[mediawiki/core@master] docs: Update database related documentation a bit

https://gerrit.wikimedia.org/r/826875

Change 826875 merged by jenkins-bot:

[mediawiki/core@master] docs: Update database related documentation a bit

https://gerrit.wikimedia.org/r/826875

Ladsgroup claimed this task.

you can always improve documentation so I think it's good enough to close this ticket.