Skip to content

Tutorials

Learning-oriented. Tutorials are hand-held lessons that get you to your first success. You may be completely unfamiliar with the library, and you don't need to fully understand every line — just follow along and you'll see the expected result at every step. By the end of all three tutorials you'll have a working project and solid muscle memory for sqlmodel-ext's core capabilities.

Learning path

Tutorials have a fixed order. Each one builds on the previous.

#TutorialTimeWhat you'll get
1Getting started15 minLibrary installed, first CRUD round-trip, the "model + Mixin = table" pattern
2Building a blog API60 minA full FastAPI backend: users, posts, comments, pagination, JOINs, relation preloading
3Adding Redis caching30 minPlug CachedTableBaseMixin into the previous project; verify cache hits and invalidation

What tutorials are not

Tutorials don't exhaustively cover the API. If a feature you need is missing from the tutorials, that's normal —

  • Looking for a method's full parameter list? Go to Reference.
  • Trying to accomplish a specific task ("how do I handle concurrent updates")? Go to How-to guides.
  • Want to understand why something is designed a certain way? Go to Explanation.

Prerequisites

All tutorials assume you know:

  • Python 3.10+
  • Basic async / await syntax
  • What SELECT / INSERT / UPDATE / DELETE do in SQL

You don't need prior experience with SQLAlchemy, SQLModel, or any ORM — tutorials introduce these concepts on demand.