Rename the table tiers to a consistent axis — `dj.Entry`, `dj.Ingest`, `dj.Compute` (keep `Manual`/`Imported`/`Computed` as permanent aliases)
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR(30日)
- 1
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 1週間以上 初心者へのやさしさ 35/100
datajoint/datajoint-python#1550 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
datajoint/datajoint-python#1547 ·
-
Make key_source restrict-only: add key_source_restriction, deprecate parent-redefining overrides オープン
難易度 5/5 1週間以上 初心者へのやさしさ 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 件 ·