Refactor: Normalize Database Schema with Libraries Table (fixes #86) #95
+329
−109
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR normalizes the database schema by introducing a dedicated libraries table and updating the documents table and related queries to reference libraries via a foreign key.
- Added migration for creating the libraries table and updating documents with library_id.
- Refactored DocumentStore to use library_id in most queries and prepared statements while leaving the documents_vec table unchanged.
- Updated tests and documentation to align with the new schema and testing guidelines.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/store/applyMigrations.test.ts | Integration tests updated to validate presence of the new libraries table and library_id column |
| src/store/DocumentStore.ts | Updated prepared statements to use library_id and added new statements for library operations |
| src/store/DocumentStore.test.ts | Adjusted tests and mocks to account for library_id and new library insertion behaviors |
| db/migrations/002-normalize-library-table.sql | Migration script added to normalize the schema by introducing the libraries table and linking it |
| ARCHITECTURE.md | Documentation updated for improved testing conventions and guidance on public API focus |
Comments suppressed due to low confidence (1)
src/store/DocumentStore.ts:124
- [nitpick] The documents_vec table still uses the legacy 'library' column while the normalization introduces 'library_id' in documents; consider updating documents_vec to use library_id for consistency across the schema.
INSERT INTO documents_vec (rowid, library, version, embedding) VALUES (?, ?, ?, ?)
arabold
force-pushed
the
refactor/86-normalize-database-schema
branch
2 times, most recently
from
a2e7b33 to
defbf02
Compare
- Added migration to introduce libraries table and update documents to use library_id foreign key - Refactored DocumentStore to use library_id internally, preserving public API - Updated all prepared statements and queries to join with libraries table - Updated and simplified tests to match new schema and mocking guidelines - Improved testing conventions in ARCHITECTURE.md to focus on public API and robust mocking - Added migration and test for schema normalization - Updated documentation to reflect new schema and testing approach
…solution Ensure the batching test for addDocuments correctly mocks the library id lookup and re-instantiates DocumentStore after patching the mock, preventing StoreError for test-lib-large-batch. This makes the test robust and prevents false negatives when batching embeddings.
arabold
force-pushed
the
refactor/86-normalize-database-schema
branch
from
defbf02 to
1e24cf2
Compare
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.
This PR implements the normalization of the database schema by introducing a new
librariestable and updating thedocumentstable (and related components) to referencelibrariesvia a foreign key (library_id).Summary of changes:
librariestable and updatedocumentsto uselibrary_id.DocumentStoreto uselibrary_idinternally, preserving the public API.librariestable.ARCHITECTURE.mdto focus on public API and robust mocking.Closes #86.