[PR #2508] [MERGED] docs: Add CockroachDB integration documentation #2499

Closed
opened 2026-02-17 17:23:28 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/2508
Author: @viragtripathi
Created: 2/5/2026
Status: Merged
Merged: 2/6/2026
Merged by: @ccurme

Base: mainHead: docs/add-cockroachdb-integration


📝 Commits (4)

  • 61ecac5 docs: Add CockroachDB integration documentation
  • afd86af fix: Use langchain.messages instead of langchain_core.messages
  • d7891f2 refactor: Update docs per maintainer review
  • 9ee0596 docs: Add CockroachDB to vector store examples section

📊 Changes

6 files changed (+765 additions, -0 deletions)

View changed files

src/images/providers/cockroachdb-icon.svg (+1 -0)
src/oss/python/integrations/chat_message_histories/cockroachdb.mdx (+153 -0)
📝 src/oss/python/integrations/providers/all_providers.mdx (+8 -0)
src/oss/python/integrations/providers/cockroachdb.mdx (+154 -0)
src/oss/python/integrations/vectorstores/cockroachdb.mdx (+418 -0)
📝 src/oss/python/integrations/vectorstores/index.mdx (+31 -0)

📄 Description

Adds comprehensive documentation for CockroachDB LangChain integration:

  • Provider overview page with setup instructions
  • Vector store integration with C-SPANN indexes
  • Chat message history integration
  • Custom CockroachDB icon

Features documented:

  • Native VECTOR type support (v24.2+)
  • Distributed C-SPANN vector indexes (v25.2+)
  • SERIALIZABLE isolation for strong consistency
  • Multi-tenancy with prefix columns
  • Advanced metadata filtering
  • Query-time performance tuning

All code examples verified against langchain-cockroachdb v0.1.0

Overview

This PR adds complete documentation for the CockroachDB integration (langchain-cockroachdb package, published to PyPI at
https://pypi.org/project/langchain-cockroachdb/).

CockroachDB is a distributed SQL database with native vector support (v24.2+) and distributed C-SPANN vector indexes (v25.2+), making it well-suited for
production AI applications requiring horizontal scalability, strong consistency, and high availability.

Pages added:

  1. Provider overview (providers/cockroachdb.mdx) - Installation, setup, and overview of all integration types
  2. Vector store (vectorstores/cockroachdb.mdx) - Complete guide for vector search with C-SPANN indexes, metadata filtering, and RAG integration
  3. Chat message history (chat_message_histories/cockroachdb.mdx) - Persistent conversation storage with session management

Custom icon: Added CockroachDB brand icon to the provider card on the all_providers page.

Type of change

Type: New documentation page

Related issues/PRs

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed - N/A (pages auto-discovered via frontmatter)

Additional notes

API Verification

All code examples were verified against the actual implementation in langchain-cockroachdb v0.1.0:

  • Checked parameter names (collection_name, vector_dimension, embeddings)
  • Verified method signatures against source code
  • Tested examples match working integration tests

Technical Accuracy

Technical claims verified against CockroachDB official documentation (v26.1):

  • Vector type availability (v24.2+)
  • C-SPANN index support (v25.2+)
  • Performance recommendations (batch insert guidance)
  • SERIALIZABLE isolation behavior

Documentation Structure

Follows existing LangChain docs patterns:

  • Frontmatter format matches other integrations (Couchbase, etc.)
  • Internal links use /oss/integrations/... pattern
  • Code examples follow established conventions
  • Custom icon added to /src/images/providers/

Files Modified

  • src/oss/python/integrations/providers/all_providers.mdx - Added CockroachDB card (alphabetically placed)
  • src/oss/python/integrations/providers/cockroachdb.mdx - NEW
  • src/oss/python/integrations/vectorstores/cockroachdb.mdx - NEW
  • src/oss/python/integrations/chat_message_histories/cockroachdb.mdx - NEW
  • src/images/providers/cockroachdb-icon.svg - NEW (brand icon)

Related Resources


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/2508 **Author:** [@viragtripathi](https://github.com/viragtripathi) **Created:** 2/5/2026 **Status:** ✅ Merged **Merged:** 2/6/2026 **Merged by:** [@ccurme](https://github.com/ccurme) **Base:** `main` ← **Head:** `docs/add-cockroachdb-integration` --- ### 📝 Commits (4) - [`61ecac5`](https://github.com/langchain-ai/docs/commit/61ecac54e6bbee39c0c7c79b62cf48a67174217d) docs: Add CockroachDB integration documentation - [`afd86af`](https://github.com/langchain-ai/docs/commit/afd86af1c359a62538037d52b0746d69af7b9106) fix: Use langchain.messages instead of langchain_core.messages - [`d7891f2`](https://github.com/langchain-ai/docs/commit/d7891f2570a5af2d6a94a46870595993098cd305) refactor: Update docs per maintainer review - [`9ee0596`](https://github.com/langchain-ai/docs/commit/9ee05963e79c00fe0b40e6712b8ee20857fb5879) docs: Add CockroachDB to vector store examples section ### 📊 Changes **6 files changed** (+765 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `src/images/providers/cockroachdb-icon.svg` (+1 -0) ➕ `src/oss/python/integrations/chat_message_histories/cockroachdb.mdx` (+153 -0) 📝 `src/oss/python/integrations/providers/all_providers.mdx` (+8 -0) ➕ `src/oss/python/integrations/providers/cockroachdb.mdx` (+154 -0) ➕ `src/oss/python/integrations/vectorstores/cockroachdb.mdx` (+418 -0) 📝 `src/oss/python/integrations/vectorstores/index.mdx` (+31 -0) </details> ### 📄 Description Adds comprehensive documentation for CockroachDB LangChain integration: - Provider overview page with setup instructions - Vector store integration with C-SPANN indexes - Chat message history integration - Custom CockroachDB icon Features documented: - Native VECTOR type support (v24.2+) - Distributed C-SPANN vector indexes (v25.2+) - SERIALIZABLE isolation for strong consistency - Multi-tenancy with prefix columns - Advanced metadata filtering - Query-time performance tuning All code examples verified against langchain-cockroachdb v0.1.0 ## Overview This PR adds complete documentation for the CockroachDB integration (`langchain-cockroachdb` package, published to PyPI at https://pypi.org/project/langchain-cockroachdb/). CockroachDB is a distributed SQL database with native vector support (v24.2+) and distributed C-SPANN vector indexes (v25.2+), making it well-suited for production AI applications requiring horizontal scalability, strong consistency, and high availability. **Pages added:** 1. **Provider overview** (`providers/cockroachdb.mdx`) - Installation, setup, and overview of all integration types 2. **Vector store** (`vectorstores/cockroachdb.mdx`) - Complete guide for vector search with C-SPANN indexes, metadata filtering, and RAG integration 3. **Chat message history** (`chat_message_histories/cockroachdb.mdx`) - Persistent conversation storage with session management **Custom icon:** Added CockroachDB brand icon to the provider card on the all_providers page. ## Type of change **Type:** New documentation page ## Related issues/PRs - Feature PR: N/A (package already published and maintained at https://github.com/cockroachdb/langchain-cockroachdb) - Package: https://pypi.org/project/langchain-cockroachdb/ (v0.1.0) ## Checklist - [x] I have read the [contributing guidelines](README.md) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [x] I have used **root relative** paths for internal links - [x] I have updated navigation in `src/docs.json` if needed - N/A (pages auto-discovered via frontmatter) ## Additional notes ### API Verification All code examples were verified against the actual implementation in `langchain-cockroachdb` v0.1.0: - Checked parameter names (`collection_name`, `vector_dimension`, `embeddings`) - Verified method signatures against source code - Tested examples match working integration tests ### Technical Accuracy Technical claims verified against CockroachDB official documentation (v26.1): - Vector type availability (v24.2+) - C-SPANN index support (v25.2+) - Performance recommendations (batch insert guidance) - SERIALIZABLE isolation behavior ### Documentation Structure Follows existing LangChain docs patterns: - Frontmatter format matches other integrations (Couchbase, etc.) - Internal links use `/oss/integrations/...` pattern - Code examples follow established conventions - Custom icon added to `/src/images/providers/` ### Files Modified - `src/oss/python/integrations/providers/all_providers.mdx` - Added CockroachDB card (alphabetically placed) - `src/oss/python/integrations/providers/cockroachdb.mdx` - NEW - `src/oss/python/integrations/vectorstores/cockroachdb.mdx` - NEW - `src/oss/python/integrations/chat_message_histories/cockroachdb.mdx` - NEW - `src/images/providers/cockroachdb-icon.svg` - NEW (brand icon) ### Related Resources - Package repository: https://github.com/cockroachdb/langchain-cockroachdb - CockroachDB vector indexes docs: https://www.cockroachlabs.com/docs/stable/vector-indexes - CockroachDB Cloud: https://cockroachlabs.cloud --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-17 17:23:28 -05:00
yindo closed this issue 2026-02-17 17:23:28 -05:00
yindo changed title from [PR #2508] docs: Add CockroachDB integration documentation to [PR #2508] [MERGED] docs: Add CockroachDB integration documentation 2026-06-05 18:18:53 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#2499