Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] Rust Sqlite migrations #3599

Merged
merged 9 commits into from
Feb 3, 2025
Merged

[ENH] Rust Sqlite migrations #3599

merged 9 commits into from
Feb 3, 2025

Conversation

HammadB
Copy link
Collaborator

@HammadB HammadB commented Jan 29, 2025

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • /
  • New functionality
    • Adds rust sqlite that copies the python codes migrations system.
    • I made the choice to COPY over the migrations from the python code so that we can add to them if needed only for the rust codebase. We can backport migrations and be careful to not let these diverge while in interim development.
    • Migration files are embedded with rust_embed crate. The design for the migrations system is not highly generic, but can grow to support more modules over time, and could theoretically be easily extracted out for use in a different system with ease.

Test plan

How are these changes tested?
I added tests for init, the validation and failure cases such as sql, hash, or version corruption.

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

None

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@HammadB HammadB marked this pull request as ready for review February 3, 2025 10:05
@HammadB HammadB mentioned this pull request Feb 3, 2025
1 task
@HammadB HammadB merged commit e83406a into main Feb 3, 2025
91 checks passed
@@ -0,0 +1,16 @@
[package]
name = "sqlite"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please name chroma-sqlite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants