Skip to content

Conversation

@codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Oct 20, 2025

Description of changes

Requires #5666

Test plan

How are these changes tested?

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

Migration plan

Are there any migrations, or any forwards/backwards compatibility changes needed in order to make sure this change deploys reliably?

Observability plan

What is the plan to instrument and monitor this change?

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

@codetheweb codetheweb marked this pull request as draft October 20, 2025 22:30
@propel-code-bot
Copy link
Contributor

propel-code-bot bot commented Oct 20, 2025

Add collection.modify() Method to Rust Client

This pull request introduces a new asynchronous modify method to the ChromaCollection struct in the Rust client (rust/chroma/src/collection.rs). The new method allows updating a collection's name and metadata via a PUT request to the server. The local struct is updated after a successful API call, ensuring the in-memory state stays consistent with the remote collection. This change is contingent on updates from an upstream pull request in the core repository (chroma/pull/5666).

Key Changes

• Added the modify async method to ChromaCollection, supporting optional new_name and new_metadata parameters.
• Sends a PUT request to the collection endpoint with the updated data using the self.send helper.
• Updates the local collection state on success by cloning and modifying the current Collection struct wrapped in Arc.

Affected Areas

rust/chroma/src/collection.rs
ChromaCollection struct
• Collection update (modify) workflow

This summary was automatically generated by @propel-code-bot

@github-actions
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)

@codetheweb codetheweb marked this pull request as ready for review October 21, 2025 18:03
@codetheweb
Copy link
Contributor Author

I am landing this without tests and will add tests after #5666 is merged since I'm currently blocked on this.

@codetheweb codetheweb merged commit ab0ca09 into main Oct 21, 2025
63 checks passed
@codetheweb codetheweb deleted the feat-rust-client-collection-modify branch October 21, 2025 18:05
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