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

Offen
#1,546 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
52/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python, sql

Rechercherichtung

Beginne damit, die Definitionen der Tier-Klassen und alle im Issue genannten Pfade zu lokalisieren: SQL-Tier-Präfixe, dj.config/Role, lookup_class_name, Tier-Erkennung, repr/Introspektion, Fehlermeldungen und dj.Diagram-Beschriftungen. Die Arbeit ist abgeschlossen, wenn Entry/Ingest/Compute mit identischem Verhalten und denselben Präfixen wie die permanenten Aliase Manual/Imported/Computed verfügbar sind und die angeforderten kanonischen Beschriftungen für 2.4.0 berücksichtigt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
Python
Sterne
197
Forks
98
Ø Merge
6 T. 10 Std.
Gemergte PRs (30 T.)
4

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus datajoint/datajoint-python

Alle Issues in datajoint/datajoint-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.