API · v0.1.1

API Reference

Generated API documentation for the CockroachDB Python Library — a uv workspace of focused packages sharing the cockroachdb namespace. Install from the GitHub Pages package index below.

Install (GitHub Pages index)

pip install --extra-index-url https://cockroachlabs.github.io/cockroachdb-python-library/simple/ \
    cockroachdb-core cockroachdb-continuum
cockroachdb API reference cockroachdb

cockroachdb

Umbrella package — pulls in the full CockroachDB Python stack.

API reference →
cockroachdb-ai API reference cockroachdb-ai

cockroachdb-ai

pgvector similarity search and RAG pipelines.

API reference →
cockroachdb-cdc API reference cockroachdb-cdc

cockroachdb-cdc

Changefeed (CDC) webhook handlers.

API reference →
cockroachdb-continuum API reference cockroachdb-continuum

cockroachdb-continuum

Plenum storage insights, vCluster tagging, Aegis, Cloud, MCP.

API reference →
cockroachdb-core API reference cockroachdb-core

cockroachdb-core

Transaction retry, pooling, follower reads, multi-region.

API reference →
cockroachdb-django API reference cockroachdb-django

cockroachdb-django

Django database backend for CockroachDB.

API reference →
cockroachdb-sqlalchemy API reference cockroachdb-sqlalchemy

cockroachdb-sqlalchemy

SQLAlchemy dialect and CockroachDB helpers.

API reference →
cockroachdb-testing API reference cockroachdb-testing

cockroachdb-testing

pytest + Testcontainers helpers.

API reference →