Plugins

Litestar has a plugin system that allows you to extend the functionality of the application. Plugins are passed to the application at startup and can pre-configure the application to manage resources, add routes, and more.

A suite of plugins is available in contrib.sqlalchemy.plugins to support using Litestar with SQLAlchemy, these include:

• litestar.contrib.sqlalchemy.plugins.SQLAlchemyPlugin: Full SQLAlchemy support

• litestar.contrib.sqlalchemy.plugins.SQLAlchemyInitPlugin: Application tooling

• litestar.contrib.sqlalchemy.plugins.SQLAlchemySerializationPlugin: Serialization support

Each of the plugins is discussed in detail in the following sections.

• SQLAlchemy Plugin
  • Example
    • Defining the Database Models
    • Setting Up an API Endpoint
    • Initializing the Database
    • Setting Up the Plugin and the App
    • Running the App
• SQLAlchemy Init Plugin
  • Dependencies
    • Renaming the dependencies
    • Configuring the before send handler
    • Configuring the plugins
  • Example
• SQLAlchemy Serialization Plugin
  • Example
  • How it works
    • Configuring data transfer