API Reference

API Reference

generate_from_schema

generate_from_schema(
    schema,
    rows=100,
    seed=None,
    engine="auto",
    spark=None,
    table_name="sample",
    realism="realistic",
    domain=None,
    custom_rules=None,
    realistic=None,
    validate=False,
    return_report=False,
)

Parameter	Meaning
schema	Supported schema input
rows	Row count, or table-count mapping for DomainSchema
seed	Optional reproducibility seed
engine	auto, pandas, or spark
spark	Optional SparkSession
table_name	Logical single-table name
realism	realistic or placeholder
domain	Optional semantic preset
custom_rules	Per-column generation rules
realistic	Backward-compatible boolean mode override
validate	Run supported validation
return_report	Return (data, report)

Related APIs

API	Purpose
explain_generation_plan	Show inferred semantic behavior
validate_generated_data	Validate schema-generated Pandas data
generate_relational	Generate custom related tables
generate_domain	Generate a ready-made domain pack
generate_cdc	Generate CDC records
generate_history	Generate SCD2 history
generate_dimensional_model	Generate facts and dimensions
generate_data_vault_model	Generate hubs, links, and satellites
generate_from_recipe	Run JSON, TOML, or simple YAML recipes
export_data	Convenience domain dataset export