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
check Columns
col Predicates
lit Predicates
Pred Predicates
TableSpec Specs
FrameSpec Specs
ForeignKey Specs
Hierarchy Specs
Registry Registry
CatSpec Registry
generate Generation
generate_batches Generation
scan Generation
estimated_size Generation
sink_parquet Generation
sink_ipc Generation
sink_csv Generation
sink_ndjson Generation
to_yaml Files and documents
to_dict Files and documents
from_dict Files and documents
FORMAT_VERSION Files and documents
from_yaml Files and documents
to_python Files and documents
to_markdown Files and documents
to_mermaid Files and documents
read Validation
inspect Validation
validate Validation
ValidationOptions Validation
ValidationReport Validation
Finding Validation
FindingCode Validation
FINDING_COLUMN Validation
assert_valid Testing
check_pipeline Testing
strategy Testing
DriftOptions Drift
DriftReport Drift
diff Drift
drift Drift
DriftCode Drift
Severity Drift
DriftFinding Drift
synthesize Profiling
profile Profiling
profile_all Profiling
synthesize_all Profiling
formats Columns
ProfileOptions Profiling
PolspecError Errors
SpecError Errors
GenerationError Errors
ValidationError Errors
MultiValidationError Errors
SerializationError Errors
RegistryError Errors

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