Rename the table tiers to a consistent axis — `dj.Entry`, `dj.Ingest`, `dj.Compute` (keep `Manual`/`Imported`/`Computed` as permanent aliases)
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 52/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
调研方向
首先定位 tier 类定义以及 issue 中提到的所有路径:SQL tier 前缀、dj.config/Role、lookup_class_name、tier 检测、repr/内省、错误消息和 dj.Diagram 标签。当 Entry/Ingest/Compute 可用,且其行为和前缀与永久别名 Manual/Imported/Computed 完全相同,并且 2.4.0 所要求的规范标签得到处理时,工作即告完成。
由索引模型根据 Issue 内容生成。
描述
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, anddj.Computedremain 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, anddj.Computeas aliases resolving to the existing tiers, so old and new names produce identical tables (same SQL prefix, sameRole). 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, anddj.Diagramtier labels emitEntry/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.Computedremain permanent aliases — kept indefinitely, never deprecated.
Related
- datajoint/datajoint-docs#267 — the tier-axis explanation (docs) and origin of this proposal.
- 主要语言
- Python
- 星标
- 197
- 派生
- 98
- 平均合并
- 6 天 7 小时
- 30 天内合并 PR
- 1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
datajoint/datajoint-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
datajoint/datajoint-python#1539 · 3 条评论 ·
-
dj.Diagram SVG output is not byte-reproducible: set iteration order leaks into node emission order 未关闭bug
难度 3/5 1-2 天 新手友好度 78/100
datajoint/datajoint-python#1551 ·
-
难度 5/5 一周以上 新手友好度 35/100
datajoint/datajoint-python#1550 ·
-
难度 5/5 一周以上 新手友好度 35/100
datajoint/datajoint-python#1547 ·
-
Make key_source restrict-only: add key_source_restriction, deprecate parent-redefining overrides 未关闭
难度 5/5 一周以上 新手友好度 35/100
datajoint/datajoint-python#1523 · 1 条评论 ·
查看 datajoint/datajoint-python 的全部 Issue
相似的 Issue
-
area: harness bug status: needs-triage
难度 2/5 1-3 小时 新手友好度 75/100
Human-Agent-Society/reef#625 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 1/5 1 小时以内 新手友好度 80/100
learningequality/kolibri#15351 · 2 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
Name consistency 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
eellak/triplestore#65 · 1 条评论 ·