SDK 准备
更新时间:2026-09-01
安装 Python SDK
环境准备
Python SDK 工具包支持在 Python 3.7 及以上的环境运行。可以通过以下命令查看当前 Python 版本:
Shell
1python --version
源码下载
若需要 Python SDK 源码,可从以下地址下载:
- GitHub 地址:https://github.com/baidu/pymochow
- Gitee 地址:https://gitee.com/baidu/pymochow
安装和卸载
推荐通过 pip 安装和卸载 Python SDK。
安装
在命令行执行:
Shell
1pip install pymochow
安装完成后,可以在 Python 中导入 pymochow。如需确认 SDK 版本,可执行:
Python
1import pymochow
2
3print(pymochow.SDK_VERSION.decode("utf-8"))
卸载
在命令行执行:
Shell
1pip uninstall pymochow
初始化客户端代码
在开始使用 SDK 之前,可以先查看创建实例快速入门,获取实例的 Endpoint 和 API Key。然后根据这些配置创建 MochowClient 对象,并通过该对象提供的接口与后端数据库交互。
Endpoint 需要包含协议,例如 http://127.0.0.1:5287。
Python
1import pymochow
2from pymochow.auth.bce_credentials import BceCredentials
3from pymochow.configuration import Configuration
4
5account = "root"
6api_key = "您的账户 API 密钥"
7endpoint = "您的实例访问端点" # 例如:http://127.0.0.1:5287
8
9config = Configuration(
10 credentials=BceCredentials(account, api_key),
11 endpoint=endpoint,
12)
13client = pymochow.MochowClient(config)
14
15# 此处可以继续调用建库、建表、写入和检索等接口。
16
17client.close()
| 参数 | 参数类型 | 是否必选 | 参数说明 |
|---|---|---|---|
| account | String | 是 | 访问 Mochow 服务的账号,例如 root。 |
| api_key | String | 是 | 账号对应的 API Key,用于签名和认证。 |
| endpoint | String | 是 | 实例访问端点,需要包含协议。 |
| credentials | BceCredentials | 是 | 由 BceCredentials(account, api_key) 创建的认证凭证。 |
pymochow.MochowClient(config) 返回 Mochow 客户端对象。创建对象本身不会校验账号、密钥或实例连通性;认证或连接错误会在实际调用接口时以异常形式返回。
客户端使用完毕后,应调用 client.close() 关闭 HTTP 会话。close() 无返回值,关闭后不应继续使用该客户端。
评价此篇文章
