Client ↗
noOriginal Documentation
Documentation Index#
Fetch the complete documentation index at: https://docs.trychroma.com/llms.txt Use this file to discover all available pages before exploring further.
Clients#
ChromaClient#
Main client class for interacting with ChromaDB. Provides methods for managing collections and performing operations on them.
CloudClient#
ChromaDB cloud client for connecting to hosted Chroma instances. Extends ChromaClient with cloud-specific authentication and configuration.
AdminClient#
Administrative client for managing ChromaDB tenants and databases. Provides methods for creating, deleting, and listing tenants and databases.
Client Methods#
heartbeat#
Sends a heartbeat request to check server connectivity.
Returns: Promise resolving to the server’s nanosecond heartbeat timestamp
listCollections#
Lists all collections in the current database.
Returns: Promise resolving to an array of Collection instances
countCollections#
Gets the total number of collections in the current database.
Returns: Promise resolving to the collection count
createCollection#
Creates a new collection with the specified configuration.
Returns: Promise resolving to the created Collection instance
getCollection#
Retrieves an existing collection by name.
Returns: Promise resolving to the Collection instance
getOrCreateCollection#
Gets an existing collection or creates it if it doesn’t exist.
Returns: Promise resolving to the Collection instance
deleteCollection#
Deletes a collection and all its data.
reset#
Resets the entire database, deleting all collections and data.
Returns: Promise that resolves when the reset is complete
version#
Gets the version of the Chroma server.
Returns: Promise resolving to the server version string
Admin Client Methods#
createTenant#
Creates a new tenant.
getTenant#
Retrieves information about a specific tenant.
Returns: Promise resolving to the tenant name
createDatabase#
Creates a new database within a tenant.
getDatabase#
Retrieves information about a specific database.
Returns: Promise resolving to database information
deleteDatabase#
Deletes a database and all its data.
listDatabases#
Lists all databases within a tenant.
Returns: Promise resolving to an array of database information