Chroma is upgrading from 0.3.29 to 0.4.0. 0.4.0 is easier to build, more durable, faster, smaller, and more extensible. This comes with a few changes:
A simplified and improved client setup. Instead of having to remember weird settings, users can just do EphemeralClient, PersistentClient or HttpClient (the underlying direct Client implementation is also still accessible)
We migrated data stores away from duckdb and clickhouse. This changes the api for the PersistentClient that used to reference chroma_db_impl="duckdb+parquet". Now we simply set is_persistent=true. is_persistent is set for you to true if you use PersistentClient.
Because we migrated away from duckdb and clickhouse - this also means that users need to migrate their data into the new layout and schema. Chroma is committed to providing extension notification and tooling around any schema and data migrations (for example - this PR!).
After upgrading to 0.4.0 - if users try to access their data that was stored in the previous regime, the system will throw an Exception and instruct them how to use the migration assistant to migrate their data. The migration assitant is a pip installable CLI: pip install chroma_migrate. And is runnable by calling chroma_migrate
-- TODO ADD here is a short video demonstrating how it works.
Please reference the readme at chroma-core/chroma-migrate to see a full write-up of our philosophy on migrations as well as more details about this particular migration.
Please direct any users facing issues upgrading to our Discord channel called #get-help. We have also created a email listserv to notify developers directly in the future about breaking changes.
TODO
[x] Migrated any duckdb+parquet strings to the new format
[ ] Notified users about the breaking change (this PR, other suggestions?)
This should land Monday the 17th
Chroma is upgrading from
0.3.29to0.4.0.0.4.0is easier to build, more durable, faster, smaller, and more extensible. This comes with a few changes:A simplified and improved client setup. Instead of having to remember weird settings, users can just do
EphemeralClient,PersistentClientorHttpClient(the underlying directClientimplementation is also still accessible)We migrated data stores away from
duckdbandclickhouse. This changes the api for thePersistentClientthat used to referencechroma_db_impl="duckdb+parquet". Now we simply setis_persistent=true.is_persistentis set for you totrueif you usePersistentClient.Because we migrated away from
duckdbandclickhouse- this also means that users need to migrate their data into the new layout and schema. Chroma is committed to providing extension notification and tooling around any schema and data migrations (for example - this PR!).After upgrading to
0.4.0- if users try to access their data that was stored in the previous regime, the system will throw anExceptionand instruct them how to use the migration assistant to migrate their data. The migration assitant is a pip installable CLI:pip install chroma_migrate. And is runnable by callingchroma_migrate-- TODO ADD here is a short video demonstrating how it works.
Please reference the readme at chroma-core/chroma-migrate to see a full write-up of our philosophy on migrations as well as more details about this particular migration.
Please direct any users facing issues upgrading to our Discord channel called #get-help. We have also created a email listserv to notify developers directly in the future about breaking changes.
TODO
duckdb+parquetstrings to the new format