Skip to content

API reference

Auto-generated from Python docstrings via mkdocstrings.

Hosted docs (Read the Docs)

RTD builds API pages from source without compiling pydantable-native. Signatures and imports resolve for most symbols; install the package locally (or use PyPI wheels) when you need to exercise native-only paths. See Installation.

Core types

Symbol
pydantable.DataFrame Open
pydantable.DataFrameModel Open
pydantable.Expr Open
pydantable.Schema Open
pydantable.PlanMaterialization Open
pydantable.plan_materialization_summary Open

Expressions

Symbol
pydantable.expressions.ColumnRef Open
pydantable.expressions.when Open
pydantable.expressions.coalesce Open
pydantable.expressions.concat Open

Modules

Module
pydantable.io Open
pydantable.errors Open
pydantable.engine Open
pydantable.fastapi Open
pydantable.selectors Open
pydantable.observe Open
pydantable.display Open
pydantable.pandas Open
pydantable.pyspark Open

Optional engines

Symbol Extra
pydantable.SqlDataFrame [sql] Open
pydantable.MongoDataFrame [mongo] Open
pydantable.SparkDataFrame [spark] Open

Beanie I/O

Symbol
pydantable.afetch_beanie Open
pydantable.aiter_beanie Open
pydantable.awrite_beanie Open
pydantable.BeanieWriteOptions Open

Narrative guides: User guide, I/O, Integrations.