跳转到主要内容

CockroachDB方言用于SQLAlchemy

项目描述

CockroachDB方言用于SQLAlchemy

先决条件

需要数据库驱动程序(DBAPI层)才能与此方言一起使用。

psycopg2

为了支持psycopg2,您必须安装以下之一:

(二进制包是开发和测试的一个实用选择,但在生产中建议使用从源构建的包。)

asyncpg

为了支持asyncpg,您必须安装

有关使用asyncpg的更多详细信息,请参阅 README.asyncpg.md

psycopg

为了支持psycopg版本3(⚠️实验性 🏗),您需要安装

与psycopg2一样,psycopg可以作为二进制文件安装用于开发和测试目的。(以二进制形式安装可以避免首先安装libpq-dev包。)

pip install psycopg[binary]

有关使用psycopg的更多详细信息,请参阅 README.psycopg.md

安装和用法

使用 pip 安装此方言的最新版本。

pip install sqlalchemy-cockroachdb

注意:此版本的方言需要SQLAlchemy 2.0或更高版本。要与较早版本的SQLAlchemy一起使用,您需要安装此方言的较早版本。

pip install sqlalchemy-cockroachdb<2.0.0

在创建 Engine 时使用 cockroachdb 连接字符串。例如,使用psycopg2连接到不安全的本地CockroachDB集群

from sqlalchemy import create_engine
engine = create_engine('cockroachdb://root@localhost:26257/defaultdb?sslmode=disable')

或者

from sqlalchemy import create_engine
engine = create_engine('cockroachdb+psycopg2://root@localhost:26257/defaultdb?sslmode=disable')

使用asyncpg进行连接

from sqlalchemy.ext.asyncio import create_async_engine
engine = create_async_engine('cockroachdb+asyncpg://root@localhost:26257/defaultdb')

使用psycopg进行同步操作

from sqlalchemy import create_engine
engine = create_engine('cockroachdb+psycopg://root@localhost:26257/defaultdb')

使用psycopg进行异步操作(⚠️实验性 🏗),请参阅 README.psycopg.md

变更日志

请参阅 CHANGES.md

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面