YAML Schema Profile Examples

YAML Schema Profile Examples

Status

Planned. YAML schema files are not accepted by generate_from_schema today.

What it is and when to use it

A YAML schema profile would let teams version reusable types and generation rules outside Python code.

Planned file shape

# Planned, not runnable today
table: customers
fields:
  customer_id:
    type: string
    prefix: CUST
  age:
    type: int
    min: 18
    max: 85
  status:
    type: string
    values: [Active, Inactive, Pending]

# Future shape
df = generate_from_schema("schemas/customers.yml", rows=1000)

Planned output preview

customer_id  age  status
CUST000001   34   Active

Supported alternative today

Use a Python type mapping plus custom_rules, then write the returned DataFrame:

df.to_csv("customers.csv", index=False)
df.to_parquet("customers.parquet", index=False)

Notes and limitations

Simple YAML dataset recipes are supported through generate_from_recipe. Recipe support is separate from schema profile support.