docs(adr): propose ADR-0001 standardize on accessionID everywhere#2263
Open
docs(adr): propose ADR-0001 standardize on accessionID everywhere#2263
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2263 +/- ##
=======================================
Coverage 40.92% 40.92%
=======================================
Files 96 96
Lines 9925 9925
=======================================
Hits 4062 4062
Misses 5264 5264
Partials 599 599
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jbygdell
previously approved these changes
Feb 23, 2026
KarlG-nbis
reviewed
Feb 23, 2026
The Go codebase uses multiple names for archive identifiers. This ADR proposes unifying on accessionID in all application-level Go code while keeping stable_id for DB query strings and column references.
pahatz
previously approved these changes
Mar 4, 2026
Expand the scope to rename stable_id → accession_id in the database as well (files, datasets, dataset_event_log FK), so the entire stack uses a single consistent term. Adds a fourth considered option (accessionID in Go only) and updates consequences and implementation guidance accordingly.
4ac56aa to
eb31a59
Compare
jbygdell
previously approved these changes
Mar 4, 2026
- Expand DB migration scope: 47 occurrences across 8 SQL files, including legacy views (local_ega, local_ega_ebi), functions/triggers, and FK - Add sda-doa (Java) to scope — Dataset.java maps stable_id column - Replace naive "DB first, then Go" with coordinated rollout strategy (dual-name support or maintenance window) - Add rollback guidance - Fix codebase counts to match actual grep results - Update confirmation criteria for fresh installs and upgrades
KarlG-nbis
approved these changes
Mar 4, 2026
jbygdell
approved these changes
Mar 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related issue(s) and PR(s)
This PR follows up on the discussion in PR #2232 by @KarlG-nbis.
Description
Proposes ADR-0001: standardize on
accessionID/accession_idacross the entirestack — Go application code, API responses, and database schema.
The current codebase uses
stableIDin DB-layer Go code andaccessionIDinAPI/message-facing code, while the DB columns use
stable_id. This ADR proposesunifying on the bioinformatics domain term everywhere.
Follows the full MADR 4.0.0 template with pros/cons for four considered options
(
accessionIDeverywhere,stableIDeverywhere,accessionIDin Go only, leave as-is).Includes a codebase survey (~232
accessionIDvs ~187stableIDoccurrences) andimplementation guidance:
ALTER TABLE ... RENAME COLUMNonsda.files,sda.datasets,and FK update in
sda.dataset_event_logADR
docs/decisions/README.md)docs/decisions/How to test