Docs map¶

Find documentation by what you want to do.

Build typed tables and transforms¶

I want to…	Start here
Install and verify the native extension	Installation
Run my first pipeline in 5 minutes	Quickstart
Define schemas and validation rules	DataFrameModel
Understand plans, lazy vs eager, and costs	Execution, Materialization
Pick dtypes and edge cases	Supported types
Fix typing in my editor	Typing

I want to…	Start here
Shortest runnable async app	Golden path
Request/response patterns and errors	FastAPI guide
Columnar JSON bodies	fastapi_columnar_bodies
Production settings and observability	fastapi_settings, fastapi_observability

I want to…	Start here
Choose lazy vs eager I/O	I/O decision tree
Format-specific guides (Parquet, CSV, SQL, …)	I/O overview
SQLModel database round-trips	SQL I/O, SQL engine
MongoDB / Beanie	Mongo engine, Beanie

I want to…	Start here
Lazy SQL transforms	SQL engine
Lazy Mongo transforms	Mongo engine
Spark / PySpark compatibility	Spark engine, PySpark UI
Pandas-shaped method names	Pandas UI
Custom execution backend	Custom engine package

I want to…	Start here
Know what behavior is guaranteed	Interface contract
Upgrade or migrate from pandas/Polars	Migration
Understand semver	Versioning
Fix errors	Troubleshooting
Look up a term	Glossary

I want to…	Start here
See where pydantable fits	Why pydantable?, Mental model
Compare to Polars or pandas	Comparisons
Review security for services	Security considerations