aiosql - Simple SQL in Python
SQL is code. Write it, version control it, comment it, and run it using files. Writing your SQL code in Python programs as strings doesn't allow you to easily reuse them in SQL GUIs or CLI tools like psql. With aiosql you can organize your SQL statements in .sql files, load them into your python application as methods to call without losing the ability to use them as you would any other SQL file.
This project supports standard and asyncio based drivers for SQLite and PostgreSQL out of the box (sqlite3, aiosqlite, psycopg2, asyncpg). Extensions to support other database drivers can be written by you! See: Database Driver Adapters
!DANGER!
This project supports asyncio based drivers and requires python versions >3.6.
Badges
Installation
pip install aiosql
Or if you you use poetry:
poetry add aiosql
Usage
users.sql
-- name: get-all-users
-- Get all user records
select userid,
username,
firstname,
lastname
from users;
-- name: get-user-by-username^
-- Get user with the given username field.
select userid,
username,
firstname,
lastname
from users
where username = :username;
You can use aiosql to load the queries in this file for use in your Python application:
import aiosql
import sqlite3
conn = sqlite3.connect("myapp.db")
queries = aiosql.from_path("users.sql", "sqlite3")
users = queries.get_all_users(conn)
# >>> [(1, "nackjicholson", "William", "Vaughn"), (2, "johndoe", "John", "Doe"), ...]
users = queries.get_user_by_username(conn, username="nackjicholson")
# >>> (1, "nackjicholson", "William", "Vaughn")
Writing SQL in a file and executing it from methods in python!
Async Usage
greetings.sql
-- name: get_all_greetings
-- Get all the greetings in the database
select greeting_id, greeting from greetings;
-- name: get_user_by_username^
-- Get a user from the database
select user_id,
username,
name
from users
where username = :username;
example.py
import asyncio
import aiosql
import aiosqlite
queries = aiosql.from_path("./greetings.sql", "aiosqlite")
async def main():
# Parallel queries!!!
async with aiosqlite.connect("greetings.db") as conn:
greetings, user = await asyncio.gather(
queries.get_all_greetings(conn),
queries.get_user_by_username(conn, username="willvaughn")
)
# greetings = [(1, "Hi"), (2, "Aloha"), (3, "Hola")]
# user = (1, "willvaughn", "William")
for _, greeting in greetings:
print(f"{greeting}, {user[2]}!")
# Hi, William!
# Aloha, William!
# Hola, William!
asyncio.run(main())
This example has an imaginary SQLite database with greetings and users. It prints greetings in various languages to the user and showcases the basic feature of being able to load queries from a sql file and call them by name in python code. It also happens to do two SQL queries in parallel using aiosqlite and asyncio.
Why you might want to use this
- You think SQL is pretty good, and writing SQL is an important part of your applications.
- You don't want to write your SQL in strings intermixed with your python code.
- You're not using an ORM like SQLAlchemy or Django, and you don't need to.
- You want to be able to reuse your SQL in other contexts. Loading it into psql or other database tools.
Why you might NOT want to use this
- You're looking for an ORM.
- You aren't comfortable writing SQL code.
- You don't have anything in your application that requires complicated SQL beyond basic CRUD operations.
- Dynamically loaded objects built at runtime really bother you.
Table of Contents
.. toctree:: :maxdepth: 2 :caption: Contents: Getting StartedDefining SQL Queries Advanced Topics Database Driver Adapters Contributing API
111 Jan 02, 2023
4 Dec 01, 2021
97 Sep 05, 2022
10 Dec 22, 2022
95 Jan 05, 2023
6 May 30, 2022
1.1k Jan 05, 2023
253 Dec 31, 2022
205 Dec 16, 2022
1 Feb 26, 2022
180 Jan 01, 2023
126 Jan 03, 2023
6 Oct 31, 2022
703 Dec 30, 2022
48 Dec 18, 2022
10 Dec 07, 2022
112 Dec 04, 2022
7 Aug 21, 2022
2 Jul 18, 2022
2.6k Dec 27, 2022