Added asynchronous support

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)

docs/advanced/asyncio.md

@@ -0,0 +1,93 @@
+# Asyncio Session and Engine
+
+In some cases, you may use asynchronous session and engine.
+This is especially important if you are building a highly loaded service.
+
+The advantage of asynchronous over synchronous is that our application does 
+not wait for a response from a query to the database, 
+but performs other tasks until it receives a response.
+
+To use the asynchronous mode, we need to install the asynchronous driver.
+
+There is aiosqlite driver for sqlite.
+
+<div class="termy">
+
+```console
+$ pip install aiosqlite
+---> 100%
+Successfully installed aiosqlite
+```
+
+</div>
+
+
+Next, you can import the asyncio module, or use the async framework.
+In this case, we will use the asyncio library.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:1]!}
+```
+
+Importing the asynchronous session and engine.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:4]!}
+```
+
+Create Model Hero.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:7-11]!}
+```
+
+Setting engine.
+
+Pay attention to the connection url,
+it clearly specifies which driver to use to connect to the database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:14-17]!}
+```
+
+Create table database.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:20-22]!}
+```
+
+Create rows.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:25-37]!}
+```
+
+Read rows. Using the asynchronous context manager.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:40-45]!}
+```
+
+We connect all the functions together.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:48-51]!}
+```
+
+Running an asynchronous function (python3.7+)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py[ln:53-55]!}
+```
+
+Running an asynchronous function (python3.6)
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001_py36.py[ln:53-56]!}
+```
+
+Full example.
+
+```Python
+{!./docs_src/advanced/asyncio/tutorial001.py!}
+```

docs_src/advanced/asyncio/tutorial001.py

@@ -0,0 +1,55 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ asyncio.run(main())

docs_src/advanced/asyncio/tutorial001_py36.py

@@ -0,0 +1,56 @@
+import asyncio
+from typing import Optional
+
+from sqlmodel import AsyncSession, Field, SQLModel, create_async_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: Optional[int] = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite+aiosqlite:///{sqlite_file_name}"
+
+engine = create_async_engine(sqlite_url, echo=True)
+
+
+async def create_db_and_tables():
+ async with engine.begin() as session:
+ await session.run_sync(SQLModel.metadata.create_all)
+
+
+async def create_heroes():
+ hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+ hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
+ hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
+
+ session = AsyncSession(engine)
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+
+ await session.commit()
+
+ await session.close()
+
+
+async def select_heroes():
+ async with AsyncSession(engine) as session:
+ statement = select(Hero)
+ results = await session.exec(statement)
+ for hero in results:
+ print(hero)
+
+
+async def main():
+ await create_db_and_tables()
+ await create_heroes()
+ await select_heroes()
+
+
+if __name__ == "__main__":
+ loop = asyncio.get_event_loop()
+ loop.run_until_complete(asyncio.wait([main()]))

mkdocs.yml

@@ -85,6 +85,7 @@ nav:
  - Advanced User Guide:
  - advanced/index.md
  - advanced/decimal.md
+ - advanced/asyncio.md
  - alternatives.md
  - help.md
  - contributing.md

pyproject.toml

@@ -53,6 +53,8 @@ isort = "^5.9.3"
 async_generator = {version = "*", python = "~3.6"}
 async-exit-stack = {version = "*", python = "~3.6"}
 
+aiosqlite = "^0.17"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

sqlmodel/__init__.py

@@ -127,8 +127,12 @@
 from sqlalchemy.types import VARCHAR as VARCHAR
 
 # Extensions and modifications of SQLAlchemy in SQLModel
-from .engine.create import create_engine as create_engine
+from .engine.create import (
+ create_engine as create_engine,
+ create_async_engine as create_async_engine,
+)
 from .orm.session import Session as Session
+from .ext.asyncio.session import AsyncSession as AsyncSession
 from .sql.expression import select as select
 from .sql.expression import col as col
 from .sql.sqltypes import AutoString as AutoString

sqlmodel/engine/create.py

@@ -4,6 +4,8 @@
 
 from sqlalchemy import create_engine as _create_engine
 from sqlalchemy.engine.url import URL
+from sqlalchemy.ext.asyncio import AsyncEngine as _AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine as _create_async_engine
 from sqlalchemy.future import Engine as _FutureEngine
 from sqlalchemy.pool import Pool
 from typing_extensions import Literal, TypedDict
@@ -137,3 +139,100 @@ def create_engine(
  current_kwargs["query_cache_size"] = query_cache_size
  current_kwargs.update(kwargs)
  return _create_engine(url, **current_kwargs) # type: ignore
+
+
+def create_async_engine(
+ url: Union[str, URL],
+ *,
+ connect_args: _ConnectArgs = Default({}), # type: ignore
+ echo: Union[bool, _Debug] = Default(False),
+ echo_pool: Union[bool, _Debug] = Default(False),
+ enable_from_linting: bool = Default(True),
+ encoding: str = Default("utf-8"),
+ execution_options: Dict[Any, Any] = Default({}),
+ future: bool = True,
+ hide_parameters: bool = Default(False),
+ implicit_returning: bool = Default(True),
+ isolation_level: Optional[_IsolationLevel] = Default(None),
+ json_deserializer: Callable[..., Any] = Default(json.loads),
+ json_serializer: Callable[..., Any] = Default(json.dumps),
+ label_length: Optional[int] = Default(None),
+ logging_name: Optional[str] = Default(None),
+ max_identifier_length: Optional[int] = Default(None),
+ max_overflow: int = Default(10),
+ module: Optional[Any] = Default(None),
+ paramstyle: Optional[_ParamStyle] = Default(None),
+ pool: Optional[Pool] = Default(None),
+ poolclass: Optional[Type[Pool]] = Default(None),
+ pool_logging_name: Optional[str] = Default(None),
+ pool_pre_ping: bool = Default(False),
+ pool_size: int = Default(5),
+ pool_recycle: int = Default(-1),
+ pool_reset_on_return: Optional[_ResetOnReturn] = Default("rollback"),
+ pool_timeout: float = Default(30),
+ pool_use_lifo: bool = Default(False),
+ plugins: Optional[List[str]] = Default(None),
+ query_cache_size: Optional[int] = Default(None),
+ **kwargs: Any,
+) -> _AsyncEngine:
+ current_kwargs: Dict[str, Any] = {
+ "future": future,
+ }
+ if not isinstance(echo, _DefaultPlaceholder):
+ current_kwargs["echo"] = echo
+ if not isinstance(echo_pool, _DefaultPlaceholder):
+ current_kwargs["echo_pool"] = echo_pool
+ if not isinstance(enable_from_linting, _DefaultPlaceholder):
+ current_kwargs["enable_from_linting"] = enable_from_linting
+ if not isinstance(connect_args, _DefaultPlaceholder):
+ current_kwargs["connect_args"] = connect_args
+ if not isinstance(encoding, _DefaultPlaceholder):
+ current_kwargs["encoding"] = encoding
+ if not isinstance(execution_options, _DefaultPlaceholder):
+ current_kwargs["execution_options"] = execution_options
+ if not isinstance(hide_parameters, _DefaultPlaceholder):
+ current_kwargs["hide_parameters"] = hide_parameters
+ if not isinstance(implicit_returning, _DefaultPlaceholder):
+ current_kwargs["implicit_returning"] = implicit_returning
+ if not isinstance(isolation_level, _DefaultPlaceholder):
+ current_kwargs["isolation_level"] = isolation_level
+ if not isinstance(json_deserializer, _DefaultPlaceholder):
+ current_kwargs["json_deserializer"] = json_deserializer
+ if not isinstance(json_serializer, _DefaultPlaceholder):
+ current_kwargs["json_serializer"] = json_serializer
+ if not isinstance(label_length, _DefaultPlaceholder):
+ current_kwargs["label_length"] = label_length
+ if not isinstance(logging_name, _DefaultPlaceholder):
+ current_kwargs["logging_name"] = logging_name
+ if not isinstance(max_identifier_length, _DefaultPlaceholder):
+ current_kwargs["max_identifier_length"] = max_identifier_length
+ if not isinstance(max_overflow, _DefaultPlaceholder):
+ current_kwargs["max_overflow"] = max_overflow
+ if not isinstance(module, _DefaultPlaceholder):
+ current_kwargs["module"] = module
+ if not isinstance(paramstyle, _DefaultPlaceholder):
+ current_kwargs["paramstyle"] = paramstyle
+ if not isinstance(pool, _DefaultPlaceholder):
+ current_kwargs["pool"] = pool
+ if not isinstance(poolclass, _DefaultPlaceholder):
+ current_kwargs["poolclass"] = poolclass
+ if not isinstance(pool_logging_name, _DefaultPlaceholder):
+ current_kwargs["pool_logging_name"] = pool_logging_name
+ if not isinstance(pool_pre_ping, _DefaultPlaceholder):
+ current_kwargs["pool_pre_ping"] = pool_pre_ping
+ if not isinstance(pool_size, _DefaultPlaceholder):
+ current_kwargs["pool_size"] = pool_size
+ if not isinstance(pool_recycle, _DefaultPlaceholder):
+ current_kwargs["pool_recycle"] = pool_recycle
+ if not isinstance(pool_reset_on_return, _DefaultPlaceholder):
+ current_kwargs["pool_reset_on_return"] = pool_reset_on_return
+ if not isinstance(pool_timeout, _DefaultPlaceholder):
+ current_kwargs["pool_timeout"] = pool_timeout
+ if not isinstance(pool_use_lifo, _DefaultPlaceholder):
+ current_kwargs["pool_use_lifo"] = pool_use_lifo
+ if not isinstance(plugins, _DefaultPlaceholder):
+ current_kwargs["plugins"] = plugins
+ if not isinstance(query_cache_size, _DefaultPlaceholder):
+ current_kwargs["query_cache_size"] = query_cache_size
+ current_kwargs.update(kwargs)
+ return _create_async_engine(url, **current_kwargs)