Page MenuHomeSoftware Heritage

docs: Update the data model description
ClosedPublic

Authored by vlorentz on Dec 14 2021, 1:31 PM.

Details

Reviewers
ardumont
Group Reviewers
Reviewers
Summary

Revision and release do not generally allow 'arbitrary' metadata;
and it was missing ExtIDs and REMD

Diff Detail

Repository
rDMOD Data model
Branch
model-docs
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 25617
Build 40057: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 40056: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D6831 (id=24764)

Rebasing onto 59ed64b08c...

Current branch diff-target is up to date.
Changes applied before test
commit ea318cbcb3dd89ebb433052ee6981598f5af70ce
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Dec 14 13:31:07 2021 +0100

    docs: Update the data model description
    
    Revision and release do not generally allow 'arbitrary' metadata;
    and it was missing ExtIDs and REMD

See https://jenkins.softwareheritage.org/job/DMOD/job/tests-on-diff/430/ for more details.

ardumont added inline comments.
docs/data-model.rst
274

I initially went for "triplet" but i think the extid version needs its own entry (you merged it inside the type).

It'se part of our key in the current db model now [1]

[1]

Indexes:
    "extid_extid_type_extid_extid_version_target_type_target_idx" UNIQUE, btree (extid_type, extid, extid_version, target_type, target)

lgtm, one remark/question/suggestion inline.

This revision is now accepted and ready to land.Dec 14 2021, 5:54 PM
docs/data-model.rst
274

This page is a high-level description, and I consider the version to be an implementation detail (or you can consider it part of the type itself).

Additionally, "triple" is the terminology used by RDF for objects that represent "(subject, relation_type, object)", which is very similar to we are doing here, so I think it's a good fit

olasd added inline comments.
docs/data-model.rst
77

We don't have modification timestamps in directories.

9d1d4a3296c84ff9a36620286301cf574bc605cd and 9e1e14a82990e47401bf3b570711fefb43cb8ed6