Record lineage between resource versions

Aperta
#9,491 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
scala

Direzione di ricerca

Start by tracing how resource versions are saved, cloned, and created from execution exports, then inspect the version API routes that could serve /{kind}/{rid}/versions/{vno}/lineage. The issue requires a lineage table, writes for uses and derived_from relations, and queries in both directions. Done when those three version-creation paths record lineage and the endpoint answers both directions; the issue does not name specific files or tests.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Task Summary

Texera records no lineage between resources. A workflow names the dataset files it reads as path strings inside its content, resolved only when it executes. An execution points to the workflow version it executed, the computing unit it ran on and the warehouse it stored in, but not to the dataset and model versions it read. So "which workflows read this dataset version?" and "where did this result come from?" have no answer, and a dataset or a model that workflows still use can be deleted without warning.

This task adds one lineage table between versions, with two relations:

  • uses: a version needs another version, such as a workflow version that reads a dataset version. It is written when the version is saved.
  • derived_from: a version was made from another, such as a dataset version that holds an execution's exported results, or a cloned workflow. It is written when the new version is made.

Clients never write lineage. The shared code of #9490 writes it, and every version answers GET /{kind}/{rid}/versions/{vno}/lineage in both directions.

Before
flowchart LR
  ex["workflow_executions"]
  wv["workflow_version"]
  cu["workflow_computing_unit"]
  wh["user_warehouse"]
  dv["dataset_version"]
  ex -- "vid" --> wv
  ex -- "cuid" --> cu
  ex -- "whid" --> wh
  wv -. "file paths as strings<br/>inside the workflow, no key" .-> dv
After
erDiagram
  resource_version ||--o{ lineage : "is the version"
  resource_version ||--o{ lineage : "is the source"
  resource_version {
    uuid rid PK
    int vno PK
  }
  lineage {
    uuid rid PK
    int vno PK
    uuid source_rid PK
    int source_vno PK
    string relation PK "uses or derived_from"
  }

For example, a forecast workflow that reads a dataset and a model, and whose execution's results are exported as a new dataset, is stored as two uses rows and one derived_from row. The arrows show how the data flows:

flowchart LR
  d["Dataset sales<br/>version 2"]
  m["Model churn<br/>version 1"]
  w["Workflow forecast<br/>version 3"]
  o["Dataset forecast<br/>version 1"]
  d -- "used by" --> w
  m -- "used by" --> w
  w -- "an execution exported" --> o
Scope

The lineage table, its writes from the shared code when versions are saved, cloned or made from an execution, and the lineage endpoint. Lineage inside a workflow, between operators and ports, is not part of this task, and reading an execution's results is #8995.

Discussion Points
  1. References and lineage in one table. zyratlo asked in #9395 where "this workflow uses this dataset version" would live. Keeping uses beside derived_from answers both questions with one query; the alternative is that each kind keeps its own references.
  2. Deleting a resource whose versions others use. It can be refused, warned about, or allowed with its lineage rows kept.
  3. Executions as nodes. An execution could be a node of its own, between the versions it read and the versions it wrote, instead of being folded into derived_from.
  4. Existing versions. uses can be back-filled from the file paths in existing workflow versions, or recorded only from now on.

Done when saving a workflow version records the dataset and model versions it uses, a cloned workflow and a dataset version made from exported results record where they came from, and the lineage endpoint answers both directions for any version.

Task Type
  • Refactor / Cleanup
  • DevOps / Deployment / CI
  • Testing / QA
  • Documentation
  • Performance
  • Other
Lingua principale
Scala
Stelle
333
Fork
202
Merge medio
3g 11h
PR unite (30g)
185

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apache/texera

Tutte le issue di apache/texera

Issue simili

Altre issue su Scala

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.