Page MenuHomeSoftware Heritage
Create Task
Maniphest T787

abstract data model (Merkle DAG) documentation
Closed, MigratedEdits Locked
Actions

Description

We should have a (implementation-independent) description of the SWH data model, to serve a few use cases/publics:

  • researchers/archivists interested in understanding out how we archive software
  • developers interested in implementing the same data model in languages other than Python/SQL

This piece of doc can be shipped as part of swh.model and is, in fact, already references by the architecture description (see target link: https://docs.softwareheritage.org/devel/swh-model/data-model.html#data-model); it was just missing a dedicated task before now.

Revisions and Commits

rDMOD Data model
rDMOD078460bb4a42 docs: add high-level description of the Merkle DAG

Related Objects
Search...

Event Timeline

zack created this task.Oct 2 2017, 1:57 PM
zack added a subtask: T709: Clean up the swh.model.git API.

I've marked this as dependent on T709 as I'd like to avoid re-documenting details that are already coming in the docstrings of D248, and instead just point to them if/when appropriate.

olasd closed subtask T709: Clean up the swh.model.git API as Resolved.Oct 5 2017, 8:28 PM
zack changed the task status from Open to Work in Progress.Feb 23 2018, 1:35 PM

We now have a preliminary version of this at https://docs.softwareheritage.org/devel/swh-model/data-model.html#data-model .
We still lack prose description of the diagram though.

zack closed this task as Resolved by committing rDMOD078460bb4a42: docs: add high-level description of the Merkle DAG.Jun 13 2018, 4:01 PM
zack added a commit: rDMOD078460bb4a42: docs: add high-level description of the Merkle DAG.
gitlab-migration changed the status of subtask T709: Clean up the swh.model.git API from Resolved to Migrated.Jan 8 2023, 4:20 PM
gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 4:23 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal