seed.mdx

title	Seed
description	Seed protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Seed Import Strategy

Defines how the engine handles existing records when a seed is applied.

**Source:** `packages/spec/src/data/seed.zod.ts`

TypeScript Usage

import { Seed, SeedMode } from '@objectstack/spec/data';
import type { Seed, SeedMode } from '@objectstack/spec/data';

// Validate data
const result = Seed.parse(data);

---

Seed

Properties

Property	Type	Required	Description
object	string	✅	Target Object Name
externalId	string | string[]	✅	Field (or composite list of fields) matched for the uniqueness check
mode	Enum<'insert' | 'update' | 'upsert' | 'replace' | 'ignore'>	✅	Conflict resolution strategy
env	Enum<'prod' | 'dev' | 'test'>[]	✅	Applicable environments
records	Record<string, any>[]	✅	Data records

---

SeedMode

Allowed Values

• insert
• update
• upsert
• replace
• ignore

---