This repository has been migrated to the official CockroachDB organization:
Please use the official repository for:
- 📦 Latest releases and updates
- 🐛 Issues and bug reports
- 🔧 Pull requests and contributions
- 📚 Documentation
- Official Repository: https://github.com/cockroachdb/langchain-cockroachdb
- PyPI Package: https://pypi.org/project/langchain-cockroachdb/
- Documentation: Available in the repository
Note: This repository is archived for historical reference only. All development happens in the official CockroachDB organization repository.
LangChain integration for CockroachDB with native vector support
Quick Start • Features • Documentation • Examples • Contributing
Build LLM applications with CockroachDB's distributed SQL database and native vector search capabilities. This integration provides:
- 🎯 Native Vector Support - CockroachDB's
VECTORtype - 🚀 C-SPANN Indexes - Distributed vector indexes optimized for scale
- 🔄 Automatic Retries - Handles serialization errors transparently
- ⚡ Async & Sync APIs - Choose based on your use case
- 🏗️ Distributed by Design - Built for CockroachDB's architecture
pip install langchain-cockroachdbimport asyncio
from langchain_cockroachdb import AsyncCockroachDBVectorStore, CockroachDBEngine
from langchain_openai import OpenAIEmbeddings
async def main():
# Initialize
engine = CockroachDBEngine.from_connection_string(
"cockroachdb://user:pass@host:26257/db"
)
await engine.ainit_vectorstore_table(
table_name="documents",
vector_dimension=1536,
)
vectorstore = AsyncCockroachDBVectorStore(
engine=engine,
embeddings=OpenAIEmbeddings(),
collection_name="documents",
)
# Add documents
await vectorstore.aadd_texts([
"CockroachDB is a distributed SQL database",
"LangChain makes building LLM apps easy",
])
# Search
results = await vectorstore.asimilarity_search(
"Tell me about databases",
k=2
)
for doc in results:
print(doc.page_content)
await engine.aclose()
asyncio.run(main())- Native
VECTORtype support with C-SPANN indexes - Advanced metadata filtering (
$and,$or,$gt,$in, etc.) - Hybrid search (full-text + vector similarity)
- Multi-tenant index support with prefix columns
- Automatic retry logic with exponential backoff
- Connection pooling with health checks
- Configurable for different workloads
- Built for SERIALIZABLE isolation
- Async-first design for high concurrency
- Sync wrapper for simple scripts
- Type-safe with full type hints
- Comprehensive test suite (92 tests)
Getting Started:
Guides:
quickstart.py- Get started in 5 minutessync_usage.py- Synchronous APIvector_indexes.py- Index optimizationhybrid_search.py- FTS + vector searchmetadata_filtering.py- Advanced querieschat_history.py- Persistent conversationsretry_configuration.py- Configuration patterns
# Clone repository
git clone https://github.com/viragtripathi/langchain-cockroachdb.git
cd langchain-cockroachdb
# Install dependencies
pip install -e ".[dev]"
# Start CockroachDB
docker-compose up -d
# Run tests
make test# Install docs dependencies
pip install -e ".[docs]"
# Serve documentation locally
mkdocs serve
# Open http://127.0.0.1:8000Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
- Distributed SQL - Scale horizontally across regions
- Native Vector Support - First-class
VECTORtype and C-SPANN indexes - Strong Consistency - SERIALIZABLE isolation by default
- Cloud Native - Deploy anywhere (IBM, AWS, GCP, Azure, on-prem)
- PostgreSQL Compatible - Familiar SQL with distributed superpowers
Apache License 2.0 - see LICENSE for details.
Built for the CockroachDB and LangChain communities.
- CockroachDB - Distributed SQL database
- LangChain - LLM application framework