Skip to content

API reference

Every name polspec exports, rendered from its own docstrings. A page here cannot describe a signature the code does not have.

Name Page
ColSpec Columns
Bound Columns
ColRule Columns
Check Columns
col Predicates
Pred Predicates
TableSpec Specs
FrameSpec Specs
ForeignKey Specs
Hierarchy Specs
Registry Registry
CatSpec Registry
generate Generation
generate_batches Generation
scan Generation
sink_parquet Generation
sink_ipc Generation
sink_csv Generation
sink_ndjson Generation
inspect Validation
validate Validation
ValidationOptions Validation
ValidationReport Validation
Finding Validation
DriftOptions Drift
DriftReport Drift
DriftFinding Drift
profile_dataframe Profiling
PolspecError Errors
SpecError Errors
GenerationError Errors
ValidationError Errors
MultiValidationError Errors
SerializationError Errors
RegistryError Errors
CliError Errors

Anything not listed here is internal: it can change in a patch release without a changelog entry.