连接 TiDB
本指南介绍如何使用 pytidb 客户端连接到 TiDB 数据库。
安装依赖项
pytidb 是一个基于 SQLAlchemy 构建的 Python 客户端。它提供了一系列高级 API，帮助你存储和搜索向量嵌入，无需编写原始 SQL。
要安装 Python 客户端，请运行以下命令：
pip install pytidb
使用连接参数进行连接
请根据你的 TiDB 部署类型选择相应步骤：
你可以创建一个 TiDB Cloud Starter 集群，然后按照以下步骤在 Web 控制台获取连接参数：
- 进入 Clusters 页面，点击目标集群名称，进入其概览页面。
- 点击右上角的 Connect。此时会弹出连接对话框，显示连接参数。
- 将连接参数复制到你的代码或环境变量中。
示例代码：
from pytidb import TiDBClient
db = TiDBClient.connect(
host="{gateway-region}.prod.aws.tidbcloud.com",
port=4000,
username="{prefix}.root",
password="{password}",
database="test",
)
按照 TiDB 快速上手 部署一个 TiDB 集群用于测试。
示例代码：
from pytidb import TiDBClient
db = TiDBClient.connect(
host="{tidb_server_host}",
port=4000,
username="root",
password="{password}",
database="test",
)
连接成功后，你可以使用 db 对象进行表操作、数据查询等。
使用连接字符串进行连接
如果你更喜欢使用连接字符串（数据库 URL），可以根据你的部署类型参考以下格式：
你可以创建一个 TiDB Cloud Starter 集群，然后按照以下步骤在 Web 控制台获取连接参数：
- 进入 Clusters 页面，点击目标集群名称，进入其概览页面。
- 点击右上角的 Connect。此时会弹出连接对话框，显示连接参数。
- 复制连接参数，并按以下格式构建连接字符串：
from pytidb import TiDBClient
db = TiDBClient.connect(
database_url="mysql+pymysql://{USERNAME}:{PASSWORD}@{HOST}:{PORT}/{DATABASE}?ssl_verify_cert=true&ssl_verify_identity=true",
)
你可以按照以下格式构建连接字符串：
from pytidb import TiDBClient
db = TiDBClient.connect(
database_url="mysql+pymysql://{USERNAME}:{PASSWORD}@{HOST}:{PORT}/{DATABASE}",
)
使用 SQLAlchemy 数据库引擎连接
如果你的应用已经有 SQLAlchemy 数据库引擎，可以通过 db_engine 参数复用：
from pytidb import TiDBClient
db = TiDBClient(db_engine=db_engine)
后续步骤
连接到 TiDB 数据库后，你可以参考以下指南，学习如何操作你的数据：