aioodbc
aioodbc is a Python 3.5+ module that makes it possible to access ODBC databases with asyncio. It relies on the awesome pyodbc library and preserves the same look and feel. aioodbc was written using async/await syntax (PEP492) and thus is not compatible with Python versions older than 3.5. Internally aioodbc employs threads to avoid blocking the event loop, threads are not that as bad as you think!. Other drivers like motor use the same approach.
aioodbc is fully compatible and tested with uvloop. Take a look at the test suite, all tests are executed with both the default event loop and uvloop.
Supported Databases
aioodbc should work with all databases supported by pyodbc. But for now the library has been tested with: SQLite, MySQL and PostgreSQL. Feel free to add other databases to the test suite by submitting a PR.
Community
Mailing List: https://groups.google.com/forum/#!forum/aio-libs
Chat room: https://gitter.im/aio-libs/Lobby
Basic Example
aioodbc is based on pyodbc and provides the same api, you just need to use yield from conn.f() or await conn.f() instead of conn.f()
Properties are unchanged, so conn.prop is correct as well as conn.prop = val.
import asyncio
import aioodbc
loop = asyncio.get_event_loop()
async def test_example():
dsn = 'Driver=SQLite;Database=sqlite.db'
conn = await aioodbc.connect(dsn=dsn, loop=loop)
cur = await conn.cursor()
await cur.execute("SELECT 42 AS age;")
rows = await cur.fetchall()
print(rows)
print(rows[0])
print(rows[0].age)
await cur.close()
await conn.close()
loop.run_until_complete(test_example())
Connection Pool
Connection pooling is ported from aiopg and relies on PEP492 features:
import asyncio
import aioodbc
loop = asyncio.get_event_loop()
async def test_pool():
dsn = 'Driver=SQLite;Database=sqlite.db'
pool = await aioodbc.create_pool(dsn=dsn, loop=loop)
async with pool.acquire() as conn:
cur = await conn.cursor()
await cur.execute("SELECT 42;")
r = await cur.fetchall()
print(r)
await cur.close()
await conn.close()
pool.close()
await pool.wait_closed()
loop.run_until_complete(test_pool())
Context Managers
Pool, Connection and Cursor objects support the context management protocol:
import asyncio
import aioodbc
loop = asyncio.get_event_loop()
async def test_example():
dsn = 'Driver=SQLite;Database=sqlite.db'
async with aioodbc.create_pool(dsn=dsn, loop=loop) as pool:
async with pool.acquire() as conn:
async with conn.cursor() as cur:
await cur.execute('SELECT 42 AS age;')
val = await cur.fetchone()
print(val)
print(val.age)
loop.run_until_complete(test_example())
Installation
In a linux environment pyodbc (hence aioodbc) requires the unixODBC library. You can install it using your package manager, for example:
$ sudo apt-get install unixodbc $ sudo apt-get install unixodbc-dev
then:
pip install aioodbc
Run tests
For testing purposes you need to install docker and the development requirements:
$ pip install -r requirements-dev.txt
In order to simplify development you should install the provided docker container. This way you don't need to install any databases or other system libraries, everything happens inside the container.
Then just execute:
$ make docker_build $ make docker_test
The test will automatically pull images and build containers with the required databases.
NOTE: Running tests requires Python 3.6 or higher.
97 Sep 05, 2022
4 Jul 30, 2022
9.7k Dec 30, 2022
9 Dec 24, 2022
139 Dec 25, 2022
1 Feb 26, 2022
8 Dec 12, 2022
3.2k Dec 30, 2022
6.9k Jan 03, 2023
3.7k Jan 08, 2023
1 Feb 08, 2022
3 Nov 24, 2021
4.2k Jan 02, 2023
558 Dec 24, 2022
1.2k Jan 03, 2023
348 Jan 03, 2023
2.6k Dec 27, 2022
95 Jan 05, 2023
3.9k Jan 08, 2023