原始查询

本指南介绍如何在你的应用程序中运行原始 SQL 查询。

使用原始 SQL 操作数据

使用 客户端.执行() 方法来执行 INSERT、UPDATE、DELETE 以及其他数据操作语句。

client.execute("INSERT INTO chunks(text, user_id) VALUES ('sample text', 5)")

执行() 和 查询() 方法都支持 参数化 SQL 功能，这有助于你在构建动态 SQL 语句时避免 SQL 注入。

client.execute(
    "INSERT INTO chunks(text, user_id) VALUES (:text, :user_id)",
    {
        "text": "sample text",
        "user_id": 6,
    },
)

使用 客户端.查询() 方法来执行 SELECT、SHOW 以及其他查询语句。

客户端.查询() 方法会返回一个 SQLQueryResult 实例，并带有一些辅助方法：

to_pydantic() 方法会返回一个 Pydantic 模型列表。

client.query("SELECT id, text, user_id FROM chunks").to_pydantic()

to_rows() 方法会返回一个元组列表，每个元组代表一行数据。

client.query("SHOW TABLES;").to_rows()

to_list() 方法会将查询结果转换为字典列表。

client.query(
    "SELECT id, text, user_id FROM chunks WHERE user_id = :user_id",
    {
        "user_id": 3
    }
).to_list()

to_pandas() 方法会将查询结果转换为 pandas.DataFrame，在 notebook 中以更易读的格式展示：

client.query("SELECT id, text, user_id FROM chunks").to_pandas()

scalar() 方法会返回结果集第一行的第一列。

client.query("SELECT COUNT(*) FROM chunks;").scalar()