DataDesigner/docs/code_reference/interface/errors.md
Andre Manoel 8b79b21298 Initialize orphan Fern docs website branch
Preserves tree from previous docs-website head: 5e47d33ea8. This branch is a CI-managed publish artifact like gh-pages; source provenance is tracked in commit messages rather than Git ancestry.
2026-05-14 01:17:51 +00:00

1.8 KiB

Interface Errors

Interface errors represent failures surfaced at the public API boundary. DataDesignerGenerationError wraps dataset generation failures from create() and preview(), DataDesignerEarlyShutdownError identifies generation runs that terminate early without producing records, and DataDesignerProfilingError wraps profiling failures from those methods. These errors inherit from data_designer.errors.DataDesignerError, allowing callers to catch either specific interface failures or the project-wide base error type.

The package-level data_designer.interface export lazily exposes DataDesignerGenerationError, DataDesignerEarlyShutdownError, and DataDesignerProfilingError. InvalidBufferValueError is defined in this module.

DataDesignerGenerationError

::: data_designer.interface.errors.DataDesignerGenerationError options: show_root_toc_entry: false

DataDesignerEarlyShutdownError

::: data_designer.interface.errors.DataDesignerEarlyShutdownError options: show_root_toc_entry: false

DataDesignerProfilingError

::: data_designer.interface.errors.DataDesignerProfilingError options: show_root_toc_entry: false

InvalidBufferValueError

::: data_designer.interface.errors.InvalidBufferValueError options: show_root_toc_entry: false