ObjectStackDataset
Dataset protocol schemas
Data Import Strategy
Defines how the engine handles existing records.
Source: packages/spec/src/data/dataset.zod.ts
TypeScript Usage
import { Dataset, DatasetMode } from '@objectstack/spec/data';
import type { Dataset, DatasetMode } from '@objectstack/spec/data';
// Validate data
const result = Dataset.parse(data);Dataset
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| object | string | ✅ | Target Object Name |
| externalId | string | ✅ | Field match for 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 |
DatasetMode
Allowed Values
insertupdateupsertreplaceignore