Rename the table tiers to a consistent axis — `dj.Entry`, `dj.Ingest`, `dj.Compute` (keep `Manual`/`Imported`/`Computed` as permanent aliases)

Aperta
#1,546 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 6 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python, sql

Direzione di ricerca

Inizia individuando le definizioni delle classi tier e tutti i percorsi menzionati nell’issue: prefissi tier di SQL, dj.config/Role, lookup_class_name, rilevamento del tier, repr/introspezione, messaggi di errore ed etichette di dj.Diagram. Il lavoro è completato quando Entry/Ingest/Compute sono disponibili con un comportamento e prefissi identici a quelli degli alias permanenti Manual/Imported/Computed e vengono gestite le etichette canoniche richieste per 2.4.0.

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

Descrizione

Full tier rename proposed in datajoint/datajoint-docs#267. Filing the class-name change here; the naming decision itself is settled and is not re-opened by this issue.

Why

The populated tiers sit on inconsistent axes: Manual names the writer, Imported names the origin, Computed names the result. A reader reasoning from the names alone lands in the wrong tier — the classic failure being an Imported table with no make() and a permanent allow_direct_insert=True papering over a real modeling error. Putting every populated tier on one axis — what the table does to get its rows — and naming it with that verb removes the confusion.

The rename

Today New primary name The table's rows…
dj.Manual dj.Entry enter the pipeline from outside (a person, an instrument, an ingestion script) — inserted directly, no make()
dj.Imported dj.Ingest are produced by make() that reads an external source
dj.Computed dj.Compute are produced by make() that derives from other DataJoint tables

dj.Lookup and dj.Part are unchanged.

Compatibility

  • dj.Manual, dj.Imported, and dj.Computed remain permanently as backward-compatible aliases — no deprecation, no migration. Existing pipelines, tutorials, and stored tier prefixes keep working; new material teaches the new names.
  • Verify the SQL tier prefix, dj.config/Role, lookup_class_name, and every tier-detection path treat each alias identically to its new name (same prefix, same reserved status) so the aliases are fully transparent on existing schemas.

Why Compute, not Derive

Derive collides with an entrenched database meaning: a derived table / derived relation is the result of a query (a subquery or view), computed on read and not stored — the opposite of a Compute table, whose rows are materialized by make() and persisted with lineage. Database-literate readers would mis-read Derive as "a view." Compute also aligns with how we frame DataJoint — a computational database. (Full discussion in datajoint-docs#267.)

Naming-form note

Entry is a noun; Ingest/Compute are verbs. Python class names read as nouns (class TuningCurve(dj.Compute):), so the verb tiers carry a short adoption cost — an ergonomics tradeoff, not a correctness objection (raised by @gtouloumes in #267). Worth reinforcing the new names consistently across the docs when adopted.

Rollout (2.3.4 → 2.4.0)

Additive and backward-compatible throughout — no deprecation at any point.

  • 2.3.4 — add the names (non-breaking). Introduce dj.Entry, dj.Ingest, and dj.Compute as aliases resolving to the existing tiers, so old and new names produce identical tables (same SQL prefix, same Role). No change to defaults, repr, or what the docs teach yet. Early adopters and new examples can use the names immediately with zero migration. Land the alias-transparency checks (prefix / Role / lookup_class_name / tier detection) in this release.
  • 2.4.0 — make them canonical. Promote the new names to primary: repr/introspection, error messages, and dj.Diagram tier labels emit Entry/Ingest/Compute; the docs and tutorials teach them by default (with the datajoint-docs#267 axis explanation and a terminology sweep shipping alongside). dj.Manual/dj.Imported/dj.Computed remain permanent aliases — kept indefinitely, never deprecated.

Related

  • datajoint/datajoint-docs#267 — the tier-axis explanation (docs) and origin of this proposal.
Lingua principale
Python
Stelle
198
Fork
103
Merge medio
6g 1h
PR unite (30g)
10

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 datajoint/datajoint-python

Tutte le issue di datajoint/datajoint-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.