search

googleapis / python-bigquery-sqlalchemy

SQLAlchemy dialect for BigQuery
MIT License
426 stars 127 forks source link

Is async support available? #1071

Open eshwen opened 4 months ago

eshwen commented 4 months ago

Issue

I have a large codebase with several intensive queries to BigQuery. I'm trying to port these synchronous queries to async to improve performance, but am unable to create an async SQLAlchemy engine. Is there a specific dialect and/or driver I can provide in order to enable async functionality? Or is there an easy workaround?

MWE

A simple script:

from sqlalchemy.ext.asyncio import create_async_engine

conn_path = "bigquery://"
engine = create_async_engine(conn_path)

Resulting in the traceback

Traceback (most recent call last):
  File "/Users/eshwen.bhal/Library/Application Support/JetBrains/PyCharm2024.1/scratches/scratch_6.py", line 4, in <module>
    engine = create_async_engine(conn_path)
  File "/Users/eshwen.bhal/Documents/GitHub/mjolnir/.venv/lib/python3.11/site-packages/sqlalchemy/ext/asyncio/engine.py", line 118, in create_async_engine
    return AsyncEngine(sync_engine)
           ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/eshwen.bhal/Documents/GitHub/mjolnir/.venv/lib/python3.11/site-packages/sqlalchemy/ext/asyncio/engine.py", line 1023, in __init__
    raise exc.InvalidRequestError(
sqlalchemy.exc.InvalidRequestError: The asyncio extension requires an async driver to be used. The loaded 'bigquery' is not async.

Environment

Linchin commented 3 months ago

Thank you for raising this issue. This feature will be dependent on async support in googleapis/python-bigquery. Please see https://github.com/googleapis/python-bigquery/issues/18 for future updates.