跳到主要内容

使用 Python 连接到 Databend

Databend 提供了以下 Python 包，使您能够开发与 Databend 交互的 Python 应用程序：

  • databend-py (推荐): 提供直接与 Databend 数据库交互的接口。它允许您执行标准的 Databend 操作，如用户登录、数据库和表的创建、数据插入/加载和查询。
  • databend-sqlalchemy: 提供了一个 SQL 工具包和 对象关系映射 以与 Databend 数据库接口。SQLAlchemy 是一个流行的 Python SQL 工具包和 ORM，而 databend-SQLAlchemy 是 SQLAlchemy 的一个方言，允许您使用 SQLAlchemy 与 Databend 交互。

这两个包都需要 Python 3.5 或更高版本。要检查您的 Python 版本，请在命令提示符中运行 python --version。要安装最新的 databend-py 或 databend-sqlalchemy 包：

# 安装 databend-py
pip install databend-py

# 安装 databend-sqlalchemy
pip install databend-sqlalchemy

数据类型映射​

下表展示了 Databend 通用数据类型与其对应的 Python 数据类型的对应关系：

DatabendPython
BOOLEANbool
TINYINTint
SMALLINTint
INTint
BIGINTint
FLOATfloat
DOUBLEfloat
DECIMALdecimal.Decimal
DATEdatetime.date
TIMESTAMPdatetime.datetime
VARCHARstr
BINARYbytes

下表展示了 Databend 半结构化数据类型与其对应的 Python 数据类型的对应关系：

DatabendPython
ARRAYlist
TUPLEtuple
MAPdict
VARIANTstr
BITMAPstr
GEOMETRYstr

在以下教程中，您将学习如何利用上述包来开发您的 Python 应用程序。教程将引导您在 Databend 中创建一个 SQL 用户，然后编写 Python 代码来创建表、插入数据和执行数据查询。

教程 -1：使用 Python 与 Databend 集成​

在开始之前，请确保您已成功安装本地 Databend。有关详细说明，请参阅 本地和 Docker 部署。

步骤 1. 准备一个 SQL 用户账户​

要将您的程序连接到 Databend 并执行 SQL 操作，您必须在代码中提供一个具有适当权限的 SQL 用户账户。如果需要，请在 Databend 中创建一个，并确保该 SQL 用户仅具有必要的权限以确保安全。

本教程使用名为 'user1' 且密码为 'abc123' 的 SQL 用户作为示例。由于程序将向 Databend 写入数据，该用户需要 ALL 权限。有关如何管理 SQL 用户及其权限，请参阅 用户与角色。

CREATE USER user1 IDENTIFIED BY 'abc123';
GRANT ALL on *.* TO user1;

步骤 2. 配置连接字符串（针对 databend-py）​

databend-py 支持多种参数，这些参数可以作为 URL 参数或作为传递给 Client 的属性进行配置。下面提供的两个示例展示了设置这些参数的等效方式，适用于常见的 DSN：

示例 1：使用 URL 参数

# 格式：<schema>://<username>:<password>@<host_port>/<database>?<connection_params>
client = Client.from_url('http://root@localhost:8000/db?secure=False&copy_purge=True&debug=True')

示例 2：使用 Client 参数

client = Client(
    host='tenant--warehouse.ch.datafusecloud.com',
    database="default",
    user="user",
    port="443",
    password="password", settings={"copy_purge": True, "force": True})

要创建有效的 DSN，请根据您的需求选择适当的连接参数，详见 这里。

步骤 3. 编写一个 Python 程序​

在这一步中，您将创建一个简单的 Python 程序，该程序与 Databend 通信。程序将涉及创建表、插入数据和执行数据查询等任务。

您将使用 databend-py 库来创建客户端实例并直接执行 SQL 查询。

  1. 安装 databend-py。
pip install databend-py
  1. 将以下代码复制并粘贴到文件 main.py 中：
main.py
from databend_py import Client

# 以名为 'user1' 且密码为 'abc123' 的 SQL 用户连接到本地 Databend 为例。
# 请根据实际情况使用您自己的值，同时保持相同的格式。
# 设置 secure=False 表示客户端将使用 HTTP 而非 HTTPS 连接到 Databend。
client = Client('user1:abc123@127.0.0.1', port=8000, secure=False)
client.execute("CREATE DATABASE IF NOT EXISTS bookstore")
client.execute("USE bookstore")
client.execute("CREATE TABLE IF NOT EXISTS booklist(title VARCHAR, author VARCHAR, date VARCHAR)")
client.execute("INSERT INTO booklist VALUES('Readings in Database Systems', 'Michael Stonebraker', '2004')")

_, results = client.execute("SELECT * FROM booklist")
for (title, author, date) in results:
  print("{} {} {}".format(title, author, date))
client.execute('drop table booklist')
client.execute('drop database bookstore')

# 关闭连接。
client.disconnect()
  1. 运行 python main.py：
Readings in Database Systems Michael Stonebraker 2004

教程 -2：使用 Python 与 Databend Cloud 集成（databend-py）​

在开始之前，请确保您已成功创建计算集群并获取连接信息。有关如何操作，请参阅 连接到计算集群。

步骤 1. 使用 pip 安装依赖​

pip install databend-py

步骤 2. 使用 databend-py 连接​

from databend_py import Client

client = Client.from_url(f"databend://{USER}:{PASSWORD}@${HOST}:443/{DATABASE}?&warehouse={WAREHOUSE_NAME}&secure=True)
client.execute('DROP TABLE IF EXISTS data')
client.execute('CREATE TABLE if not exists data (x Int32,y VARCHAR)')
client.execute('DESC  data')
client.execute("INSERT INTO data (Col1,Col2) VALUES ", [1, 'yy', 2, 'xx'])
_, res = client.execute('select * from data')
print(res)

教程 -3：使用 Python 与 Databend Cloud 集成（databend-sqlalchemy）​

在开始之前，请确保您已成功创建计算集群并获取连接信息。有关如何操作，请参阅 连接到计算集群。

步骤 1. 使用 pip 安装依赖​

pip install databend-sqlalchemy

步骤 2. 使用 Databend SQLAlchemy 连接​

from databend_sqlalchemy import connector

cursor = connector.connect(f"databend://{USER}:{PASSWORD}@${HOST}:443/{DATABASE}?&warehouse={WAREHOUSE_NAME}).cursor()
cursor.execute('DROP TABLE IF EXISTS data')
cursor.execute('CREATE TABLE IF NOT EXISTS  data( Col1 TINYINT, Col2 VARCHAR )')
cursor.execute("INSERT INTO data (Col1,Col2) VALUES ", [1, 'yy', 2, 'xx'])
cursor.execute("SELECT * FROM data")
print(cursor.fetchall())
提示

请将代码中的 {USER}, {PASSWORD}, {HOST}, {WAREHOUSE_NAME} 和 {DATABASE} 替换为您的连接信息。有关如何获取连接信息，请参阅 连接到仓库。

这篇文章对您有帮助吗？
Yes
No
加入我们的社区
GitHub
🌟 7.6K Stars
知乎
bilibili
开源中国
微信