Chroma
Set up the Chroma destination connector using this guide.
Output schema
One stream collects data from all source streams. It exists in a collection in Chroma. You define its name, which Airbyte validates and corrects.
Each record receives a generated UUID string as its document id. The defined embeddings are stored as embeddings. Text field data is stored as documents. Metadata field data is stored as metadata.
Supported sync modes
| Sync mode | Supported? |
|---|---|
| Full Refresh - Overwrite | Yes |
| Full Refresh - Append | Yes |
| Full Refresh - Overwrite + Deduped | Yes |
| Incremental Sync - Append | Yes |
| Incremental Sync - Append + Deduped | Yes |
Get started (Airbyte Open Source)
You can connect to a Chroma instance in client/server mode or local persistent mode. In local persistent mode, the database file is saved at the path defined by the path config parameter. path must be an absolute path prefixed with /local.
:::danger
Kubernetes doesn’t support Persistent Client mode.
:::
By default, the LOCAL_ROOT env variable in the .env file is set to /tmp/airbyte_local.
Docker mounts the local mount onto LOCAL_ROOT. By default, this substitutes /local with /tmp/airbyte_local.
:::caution
Make sure Docker Desktop can access /tmp. On MacOS, it must also access /private because /tmp links to /private. Otherwise, it won’t work. Allow access through “File sharing” in Settings -> Resources -> File sharing -> add the one or two above folder, then select “Apply & restart”.
:::
Requirements
To use the Chroma destination, you’ll need:
- An account with API access for OpenAI or Cohere, depending on your chosen embedding method. You don’t need one for default chroma embedding function.
- A Chroma db instance in client/server mode or persistent mode
- Credentials for client/server mode
- A Local File path for Persistent mode
Configure network access
Make sure Airbyte can access your Chroma database. If it’s within a VPC, allow access from the IP you’re using to expose Airbyte.
Set up the Chroma destination in Airbyte
You now have everything needed to configure Chroma as a destination in the UI. You’ll need the following information:
- (Required) Text fields to embed
- (Optional) Text splitter Options for configuring the chunking process provided by the Langchain Python library.
- (Required) Fields to store as metadata
- (Required) Collection The Chroma db collection name for storing your data
- (Required) Authentication method
- For client/server mode
- Host, for example localhost
- Port, for example 8000
- Username (Optional)
- Password (Optional)
- For persistent mode
- Path The path to the local database file.
pathmust be an absolute path prefixed with/local.
- Path The path to the local database file.
- For client/server mode
- (Optional) Embedding
- OpenAI API key when using OpenAI for embedding
- Cohere API key when using Cohere for embedding
- Embedding Field name and Embedding dimensions when getting embeddings from stream records
Namespace support
This destination supports namespaces.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.0.56 | 2026-10-07 | 88197 | Fix username/password (client/server mode) connections failing with No module named chromadb.auth.basic by using the chromadb.auth.basic_authn.BasicAuthClientProvider path required by chromadb 0.5+ |
| 0.0.55 | 2026-08-13 | 84361 | Update the CDK to remediate CVE-2025-68664 in the langchain dependency |
| 0.0.54 | 2025-05-03 | 59326 | Update dependencies |
| 0.0.53 | 2025-04-26 | 58256 | Update dependencies |
| 0.0.52 | 2025-04-12 | 57652 | Update dependencies |
| 0.0.51 | 2025-04-05 | 57169 | Update dependencies |
| 0.0.50 | 2025-03-29 | 56624 | Update dependencies |
| 0.0.49 | 2025-03-22 | 56120 | Update dependencies |
| 0.0.48 | 2025-03-08 | 55393 | Update dependencies |
| 0.0.47 | 2025-03-01 | 54852 | Update dependencies |
| 0.0.46 | 2025-02-22 | 54209 | Update dependencies |
| 0.0.45 | 2025-02-15 | 53930 | Update dependencies |
| 0.0.44 | 2025-02-08 | 53428 | Update dependencies |
| 0.0.43 | 2025-02-01 | 52941 | Update dependencies |
| 0.0.42 | 2025-01-25 | 52189 | Update dependencies |
| 0.0.41 | 2025-01-18 | 51744 | Update dependencies |
| 0.0.40 | 2025-01-11 | 51296 | Update dependencies |
| 0.0.39 | 2025-01-04 | 50913 | Update dependencies |
| 0.0.38 | 2024-12-28 | 50445 | Update dependencies |
| 0.0.37 | 2024-12-21 | 50221 | Update dependencies |
| 0.0.36 | 2024-12-14 | 48956 | Update dependencies |
| 0.0.35 | 2024-11-25 | 48668 | Update dependencies |
| 0.0.34 | 2024-11-04 | 48236 | Update dependencies |
| 0.0.33 | 2024-10-29 | 47053 | Update dependencies |
| 0.0.32 | 2024-10-12 | 46434 | Update dependencies |
| 0.0.31 | 2024-09-28 | 46192 | Update dependencies |
| 0.0.30 | 2024-09-21 | 45553 | Update dependencies |
| 0.0.29 | 2024-09-07 | 45322 | Update dependencies |
| 0.0.28 | 2024-08-31 | 45017 | Update dependencies |
| 0.0.27 | 2024-08-24 | 44717 | Update dependencies |
| 0.0.26 | 2024-08-22 | 44530 | Update test dependencies |
| 0.0.25 | 2024-08-17 | 44292 | Update dependencies |
| 0.0.24 | 2024-08-12 | 43734 | Update dependencies |
| 0.0.23 | 2024-08-10 | 43702 | Update dependencies |
| 0.0.22 | 2024-08-03 | 43133 | Update dependencies |
| 0.0.21 | 2024-07-27 | 42628 | Update dependencies |
| 0.0.20 | 2024-07-20 | 42160 | Update dependencies |
| 0.0.19 | 2024-07-13 | 41802 | Update dependencies |
| 0.0.18 | 2024-07-10 | 41384 | Update dependencies |
| 0.0.17 | 2024-07-09 | 41165 | Update dependencies |
| 0.0.16 | 2024-07-06 | 40926 | Update dependencies |
| 0.0.15 | 2024-06-29 | 40634 | Update dependencies |
| 0.0.14 | 2024-06-27 | 40215 | Replaced deprecated AirbyteLogger with logging.Logger |
| 0.0.13 | 2024-06-25 | 40431 | Update dependencies |
| 0.0.12 | 2024-06-23 | 40222 | Update dependencies |
| 0.0.11 | 2024-06-22 | 40068 | Update dependencies |
| 0.0.10 | 2024-04-15 | #37333 | Updated CDK & pytest version to fix security vulnerabilities |
| 0.0.9 | 2023-12-11 | #33303 | Fix bug with embedding special tokens |
| 0.0.8 | 2023-12-01 | #32697 | Allow omitting raw text |
| 0.0.7 | 2023-11-16 | #32608 | Support deleting records for CDC sources |
| 0.0.6 | 2023-11-13 | #32357 | Improve spec schema |
| 0.0.5 | 2023-10-23 | #31563 | Add field mapping option |
| 0.0.4 | 2023-10-15 | #31329 | Add OpenAI-compatible embedder option |
| 0.0.3 | 2023-10-04 | #31075 | Fix OpenAI embedder batch size |
| 0.0.2 | 2023-09-29 | #30820 | Update CDK |
| 0.0.1 | 2023-09-08 | #30023 | 🎉 New Destination: Chroma (Vector Database) |