seed/execute

Type Aliases

SeedExecutionPlan

type SeedExecutionPlan = object;

Defined in: platform-utils/src/seed/execute.ts:6

Properties

Property	Modifier	Type	Defined in
`clearBefore?`	`readonly`	`ReadonlyArray`<`string`>	platform-utils/src/seed/execute.ts:8
`mutations`	`readonly`	`ReadonlyArray`<{ `collection_name`: `string`; `payloads`: `ReadonlyArray`<`Record`<`string`, `unknown`>>; }>	platform-utils/src/seed/execute.ts:9
`version`	`readonly`	`1`	platform-utils/src/seed/execute.ts:7

Functions

seedProvenanceRecords()

function seedProvenanceRecords(input): Record<string, unknown>[];

Defined in: platform-utils/src/seed/execute.ts:21

Parameters

Parameter	Type
`input`	{ `adminId`: `string`; `summaries`: readonly `SeedProvenanceSummary`[]; `templateKey`: `string`; }
`input.adminId`	`string`
`input.summaries`	readonly `SeedProvenanceSummary`[]
`input.templateKey`	`string`

Returns

Record<string, unknown>[]

seedTemplateDataFromPlan()

function seedTemplateDataFromPlan(input): Promise<void>;

Defined in: platform-utils/src/seed/execute.ts:249

Execute a seed plan against a live tenant DB. The caller resolves the tenant connection string (live zone) so this module stays free of apps/core facilities.

Parameters

Parameter	Type
`input`	{ `adminId`: `string`; `liveUrl`: `string`; `log`: (`message`) => `void`; `orgId`: `string`; `orgName`: `string`; `plan`: `SeedExecutionPlan`; `templateKey`: `string`; }
`input.adminId`	`string`
`input.liveUrl`	`string`
`input.log`	(`message`) => `void`
`input.orgId`	`string`
`input.orgName`	`string`
`input.plan`	`SeedExecutionPlan`
`input.templateKey`	`string`

Returns

Promise<void>