aiosql - 简单的Python SQL工具

aiosql - 简单的Python SQL工具

aiosql Simple SQL in Python 项目地址: https://gitcode.com/gh_mirrors/ai/aiosql

1. 项目介绍

aiosql 是一个开源项目，它允许开发者在 Python 程序中使用 .sql 文件来组织 SQL 语句，这样可以在不失去使用其他 SQL 文件的能力的同时，将它们加载到 Python 应用程序中作为方法调用。该项目的目标是支持标准的 PEP 249 接口和基于 asyncio 的数据库驱动程序，从而支持多种 SQL 数据库，包括 SQLite、PostgreSQL、MySQL、MariaDB、DuckDB 和 MS SQL Server。

2. 项目快速启动

首先，您需要安装 aiosql。可以使用 pip 命令进行安装：

pip install aiosql

然后，创建一个 SQL 文件（例如 greetings.sql），并编写您的 SQL 查询：

-- name: get_all_greetings()
-- 获取数据库中的所有问候语
SELECT greeting_id, greeting FROM greetings ORDER BY 1;

在 Python 代码中，您可以这样加载和使用 SQL 查询：

import aiosql
import sqlite3

# 加载 SQL 查询
queries = aiosql.from_path("greetings.sql", "sqlite3")

# 连接到数据库
with sqlite3.connect("greetings.db") as conn:
    # 获取所有问候语
    for _, greeting in queries.get_all_greetings(conn):
        print(greeting)

如果您想要异步执行查询，可以使用 aiosqlite：

import asyncio
import aiosqlite

# 加载 SQL 查询
queries = aiosql.from_path("greetings.sql", "aiosqlite")

async def main():
    # 异步连接到数据库
    async with aiosqlite.connect("greetings.db") as conn:
        # 异步获取所有问候语
        greetings = await queries.get_all_greetings(conn)
        for _, greeting in greetings:
            print(greeting)

# 运行异步主函数
asyncio.run(main())

3. 应用案例和最佳实践

• 组织 SQL 代码：将 SQL 代码放入独立的 .sql 文件中，可以方便地进行版本控制和复用。
• 参数化查询：使用命名参数来避免 SQL 注入攻击，并提高代码的可读性。
• 异步操作：利用 asyncio 和异步数据库驱动程序，可以有效地处理大量并发数据库操作。

4. 典型生态项目

• AnoDB：一个数据库连接和查询的封装类，它可以自动重连并在需要时缓存查询结果。
• 其他数据库驱动程序：如 psycopg2、PyMySQL、asyncpg 等，它们可以与 aiosql 配合使用，以支持更多类型的数据库。

aiosql Simple SQL in Python 项目地址: https://gitcode.com/gh_mirrors/ai/aiosql