Python应用对接Apache CouchDB的推荐方案及工具选型咨询

1. 继续使用couchdb-python是否可行？ #

• 如果你的CouchDB版本是2.x及以下，且仅需基础CRUD（创建、读取、更新、删除）操作，它暂时可以正常使用——CouchDB核心REST API兼容性极强，旧客户端通常能和旧版本服务端稳定交互。
• 但不推荐长期依赖：
  • 项目自2019年停止维护，无法适配CouchDB 3.x+的新特性（比如增强权限系统、分区数据库、批量操作优化等）。
  • 后续遇到bug、安全漏洞或兼容性问题，不会有官方修复，风险随时间递增。

2. 推荐的替代方案 #

直接调用REST API（最灵活可靠） #

CouchDB原生提供完整的REST API，用requests（同步）或aiohttp（异步）直接调用，完全跟随官方API更新，没有第三方库的限制，适合需要精细控制或使用新特性的场景。示例代码：

import requests

# 配置连接信息
COUCHDB_HOST = "http://localhost:5984"
DB_NAME = "my_database"
AUTH = ("admin", "your_password")  # 开启认证时需填写

# 创建数据库
resp = requests.put(f"{COUCHDB_HOST}/{DB_NAME}", auth=AUTH)
print(resp.json())

# 插入文档
new_doc = {"type": "user", "name": "Bob", "email": "bob@example.com"}
resp = requests.post(f"{COUCHDB_HOST}/{DB_NAME}", json=new_doc, auth=AUTH)
print("插入结果:", resp.json())

# 查询文档
doc_id = resp.json()["id"]
resp = requests.get(f"{COUCHDB_HOST}/{DB_NAME}/{doc_id}", auth=AUTH)
print("查询到的文档:", resp.json())

couchdb3（适配CouchDB 3.x+） #

专为CouchDB 3.x及更高版本开发，维护活跃，支持所有新特性，API设计与旧couchdb-python接近，迁移成本低。示例：

from couchdb3 import Server

# 连接服务器
server = Server("http://admin:your_password@localhost:5984/")

# 创建或获取数据库
db = server.create("my_database", exist_ok=True)

# 插入文档
doc = {"type": "user", "name": "Alice"}
doc_id, doc_rev = db.save(doc)

# 查询文档
fetched_doc = db.get(doc_id)
print(fetched_doc)

aiocouch（异步场景首选） #

适用于FastAPI、Sanic等异步框架项目，基于aiohttp实现，支持异步操作，维护状态良好，适配CouchDB 2.x+。示例：

import asyncio
from aiocouch import Server

async def main():
    # 连接服务器
    server = await Server("http://admin:your_password@localhost:5984/")
    
    # 获取或创建数据库
    db = await server.get("my_database") or await server.create("my_database")
    
    # 插入文档
    doc = await db.create({"type": "user", "name": "Charlie"})
    print(f"插入文档ID: {doc.id}")
    
    # 查询文档
    fetched_doc = await db[doc.id]
    print(fetched_doc)

asyncio.run(main())

内容的提问来源于stack exchange，提问作者theo