Overview of APIs

PackageSource

Support the compatibility between flask_sqlalchemy and flask_sqlalchemy_lite. It allows users to make minimal changes when they need to migrate from either one of these two packages to each other.

The main motivation of this package is because flask_sqlalchemy_lite does not support python<=3.8. This package is designed for providing the similar usages when users have to make the flask_sqlalchemy_lite working with python<=3.8 by using flask_sqlalchemy. In this case, users can get rid of the difficulty of maintaining two sets of codes.

This graph shows the high-level overview of the whole package, where only the modules are included.

Modules

Member	Description
auto	Methods used for creating the SQLAlchemy extension in the compatible mode.
backdict	The implementation of a modified dict.
backends	The backends of the flask_sqlalchemy_compat package.
flask_sa_api	The proxy wrapper providing the APIs mimicking the behavior of flask_sqlalchemy.SQLAlchemy().
flask_sa_lite_api	The proxy wrapper providing the APIs mimicking the behavior of flask_sqlalchemy_lite.SQLAlchemy().
protocols	The customized protocol type hints used by this package.
utilities	The extra functionalities used for hooking the original SQLAlchemy extensions.

Aliases

Member	Alias of
SQLAlchemyProtocol	fsc.protocols.SQLAlchemyProtocol
SQLAlchemyLiteProtocol	fsc.protocols.SQLAlchemyLiteProtocol
ModelProtocol	fsc.protocols.ModelProtocol
TableNameGetter	fsc.utilities.TableNameGetter
QueryGetter	fsc.utilities.QueryGetter
SQLAlchemyProxy	fsc.flask_sa_api.SQLAlchemyProxy
SQLAlchemyLiteProxy	fsc.flask_sa_lite_api.SQLAlchemyLiteProxy
as_flask_sqlalchemy	fsc.flask_sa_api.as_flask_sqlalchemy
as_flask_sqlalchemy_lite	fsc.flask_sa_lite_api.as_flask_sqlalchemy_lite
get_flask_sqlalchemy	fsc.auto.get_flask_sqlalchemy
get_flask_sqlalchemy_proxy_ver	fsc.auto.get_flask_sqlalchemy_proxy_ver
get_flask_sqlalchemy_lite	fsc.auto.get_flask_sqlalchemy_lite
get_flask_sqlalchemy_lite_proxy_ver	fsc.auto.get_flask_sqlalchemy_lite_proxy_ver