Page MenuHomeSoftware Heritage

Have comments on all columns of all databases
Closed, ResolvedPublic

Description

Check the databases have the necessary comments on their column.

Services/modules concerned are:

  • swh-storage
  • swh-scheduler
  • swh-indexer

Each of those modules should have a folder sql containing an existing schema file.
This should be amended to add the necessary information (missing column description).

This implies also a sql/upgrade/<dbversion>.sql file with the diff amending the schema.
(One can use D1133 as a model to see how to proceed)

Event Timeline

twitu added a subscriber: twitu.Jun 12 2019, 6:21 PM

Can you provide a few more details so I can work on this? Maybe which packages will be affected and what is expected in the comments.

twitu added a comment.Jun 12 2019, 7:44 PM

modules swh-scheduler, swh-indexer, swh-storage, all seem to have column comments written in 30-swh-schema.sql

is there anything left to be done to close the task?

ardumont updated the task description. (Show Details)Jun 13 2019, 12:31 PM
ardumont updated the task description. (Show Details)
ardumont added a project: Easy hack.
twitu added a comment.Jun 13 2019, 6:54 PM

there seems to be an inconsistency between sql/upgrades and latest sql version in swh-storage. The latest upgrade is 136.sql while the version in 30-swh-schema.sql is 133. Should I name the next upgrade 137?

The latest upgrade is 136.sql while the version in 30-swh-schema.sql is 133. Should I name the next upgrade 137?

Nice catch.
That should indeed be in sync (for some epsilon of current diffs not landed).
So yeah, my take is that it should say current 136 in schema.sql.

twitu added a comment.Jun 14 2019, 8:30 AM

Have added a few comments in D1582

twitu added a comment.Jun 14 2019, 5:18 PM

All columns are already commented in swh-indexer

ardumont updated the task description. (Show Details)Jun 14 2019, 5:40 PM
twitu added a comment.Jun 15 2019, 5:22 PM

All columns commented in swh-scheduler, waiting review.
Some columns for swh-storage required a small discussion to frame appropriate comments.

D1582 has been pushed the task can be closed

twitu updated the task description. (Show Details)Jun 24 2019, 6:28 PM
twitu closed this task as Resolved.Jun 25 2019, 6:25 PM