diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-07-04 12:21:36 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-08-13 18:41:53 -0400 |
commit | 5fb0138a3220161703e6ab1087319a669d14e7f4 (patch) | |
tree | 25d006b30830ce6bc71f7a69bed9b570e1ae9654 /examples/asyncio/basic.py | |
parent | cd03b8f0cecbf72ecd6c99c4d3a6338c8278b40d (diff) | |
download | sqlalchemy-5fb0138a3220161703e6ab1087319a669d14e7f4.tar.gz |
Implement rudimentary asyncio support w/ asyncpg
Using the approach introduced at
https://gist.github.com/zzzeek/6287e28054d3baddc07fa21a7227904e
We can now create asyncio endpoints that are then handled
in "implicit IO" form within the majority of the Core internals.
Then coroutines are re-exposed at the point at which we call
into asyncpg methods.
Patch includes:
* asyncpg dialect
* asyncio package
* engine, result, ORM session classes
* new test fixtures, tests
* some work with pep-484 and a short plugin for the
pyannotate package, which seems to have so-so results
Change-Id: Idbcc0eff72c4cad572914acdd6f40ddb1aef1a7d
Fixes: #3414
Diffstat (limited to 'examples/asyncio/basic.py')
-rw-r--r-- | examples/asyncio/basic.py | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/examples/asyncio/basic.py b/examples/asyncio/basic.py new file mode 100644 index 000000000..05cdd8a05 --- /dev/null +++ b/examples/asyncio/basic.py @@ -0,0 +1,71 @@ +"""Illustrates the asyncio engine / connection interface. + +In this example, we have an async engine created by +:func:`_engine.create_async_engine`. We then use it using await +within a coroutine. + +""" + + +import asyncio + +from sqlalchemy import Column +from sqlalchemy import Integer +from sqlalchemy import MetaData +from sqlalchemy import String +from sqlalchemy import Table +from sqlalchemy.ext.asyncio import create_async_engine + + +meta = MetaData() + +t1 = Table( + "t1", meta, Column("id", Integer, primary_key=True), Column("name", String) +) + + +async def async_main(): + # engine is an instance of AsyncEngine + engine = create_async_engine( + "postgresql+asyncpg://scott:tiger@localhost/test", echo=True, + ) + + # conn is an instance of AsyncConnection + async with engine.begin() as conn: + + # to support SQLAlchemy DDL methods as well as legacy functions, the + # AsyncConnection.run_sync() awaitable method will pass a "sync" + # version of the AsyncConnection object to any synchronous method, + # where synchronous IO calls will be transparently translated for + # await. + await conn.run_sync(meta.drop_all) + await conn.run_sync(meta.create_all) + + # for normal statement execution, a traditional "await execute()" + # pattern is used. + await conn.execute( + t1.insert(), [{"name": "some name 1"}, {"name": "some name 2"}] + ) + + async with engine.connect() as conn: + + # the default result object is the + # sqlalchemy.engine.Result object + result = await conn.execute(t1.select()) + + # the results are buffered so no await call is necessary + # for this case. + print(result.fetchall()) + + # for a streaming result that buffers only segments of the + # result at time, the AsyncConnection.stream() method is used. + # this returns a sqlalchemy.ext.asyncio.AsyncResult object. + async_result = await conn.stream(t1.select()) + + # this object supports async iteration and awaitable + # versions of methods like .all(), fetchmany(), etc. + async for row in async_result: + print(row) + + +asyncio.run(async_main()) |