generated from john/python-template
3.4 KiB
3.4 KiB
implementation_plan_v2
Goal
Replace the current V1 SQLModel schema with the approved V2 schema and make sure every database operation works through the existing async SQLAlchemy/SQLModel session layer.
Use a fresh database. There will be no migrations, data conversion, legacy compatibility shims, or parallel V1/V2 code paths.
Current Project Impact
src/transcription/db/models.pystill defines the V1Document,Source,Job, andRevisiontables.- The V2 target adds
Person,DocumentPerson, andJobSource, moves revisions ontoSource, and removes the directSource.job_idrelationship. - The engine, session factory, transaction handling, and PostgreSQL async support already exist and do not need to be rewritten.
- Async CRUD currently lives in
DocumentService,JobService,TranscriptionService, and the upload record helper. Their queries and eager-loading options depend on V1 relationships. - Existing tests cover only part of the schema and CRUD surface.
Implementation
1. Update the schema
- Replace the models in
src/transcription/db/models.pywith the approved V2 tables, enums, relationships, foreign keys, constraints, and indexes. - Remove
Revision,Source.job_id, and the transcription fields that no longer belong onJob. - Keep
create_all()as the schema bootstrap for a fresh database. - Delete
_ensure_sqlite_compat_columns()and all schema patching fromsrc/transcription/db/operations.py. - Keep the Python models and
docs/schema_v2.mdconsistent.
2. Align the async CRUD methods
- Keep the existing
ServiceBasesession and transaction pattern. - Update document CRUD to load and manage its ordered
Sourcerows andDocumentPersonlinks. - Update job CRUD and queue queries to use
JobSourceinstead ofSource.job_id. - Add the missing async CRUD operations for
Person,Source,DocumentPerson, andJobSourceusing the existing service style. Do not add another repository abstraction. - Replace revision CRUD with direct updates to
Source.revised_textandSource.date_revised. - Remove the temporary transcript compatibility aliases instead of redirecting them.
- Update only direct database call sites that construct or query these records; UI and worker feature changes are not part of this work.
3. Verify the schema and CRUD
- Update the schema bootstrap test to expect
person,document,document_person,source,job, andjob_source, with norevisiontable. - Add async create, read, update, delete, list, and filtered-query tests for each entity that exposes those operations.
- Test relationship loading, page ordering, uniqueness constraints, delete behavior, status values, and
JobSourceJSON fields. - Test both service-owned sessions and caller-provided sessions so flush/commit behavior remains correct.
- Run the focused database and service tests, then the full suite with
uv run pytest.
Done When
- A fresh database is created directly from the V2 SQLModel metadata.
- All async CRUD methods pass against the V2 relationships and fields.
- No code references
Revision,Source.job_id, removedJobtranscription fields, or compatibility aliases. - The focused tests and full test suite pass.
Out of Scope
- Database migrations or preservation of V1 data
- Legacy compatibility code
- Database engine or session-layer rewrites
- UI redesign, batch orchestration, worker concurrency, deployment, and operational runbooks