Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
VectorDBClient
✓ from tcvectordb import VectorDBClient
enums
✓ from tcvectordb.model.enum import FieldType, IndexType, MetricType
✗ from tcvectordb.enums import ...
enums moved to model.enum in v2.x
Creates a database and collection with HNSW index.
import os
from tcvectordb import VectorDBClient
from tcvectordb.model.enum import FieldType, IndexType, MetricType
from tcvectordb.model.index import Index, IndexField
client = VectorDBClient(
url=os.environ.get('VECTORDB_URL', ''),
username=os.environ.get('VECTORDB_USERNAME', 'root'),
key=os.environ.get('VECTORDB_KEY', ''),
)
db = client.create_database('test_db')
index = Index(
IndexField(name='id', field_type=FieldType.String, primary_key=True),
IndexField(name='vector', field_type=FieldType.Vector, dimension=3, index_type=IndexType.HNSW, metric_type=MetricType.COSINE)
)
collection = db.create_collection('test_col', shard=1, replicas=0, index=index)
print('Collection created successfully')
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'tcvectordb'
SDK not installed or installation failed.
fixRun `pip install tcvectordb`.
ImportError: cannot import name 'IndexType' from 'tcvectordb'
Enums were relocated in v2.0.
fixImport from `tcvectordb.model.enum` instead: `from tcvectordb.model.enum import IndexType`.
tcvectordb.exception.VectorDBException: Authentication failed
Incorrect username or key, or using password parameter.
fixEnsure `username` and `key` are correct. Do not use `password`; use `key`.
Upgrade
Version history
2.1.1latest on PyPI · released Mar 30, 2026
Audit
Dependencies
requestsrequiredHTTP client for API calls