Class SoftFKConfigEmitter

Manages soft PK and FK definitions in the additionalSchemaInfo JSON file. Mirrors the integration schema-builder's SoftFKConfigEmitter but works with SchemaEngine's generic TableDefinition types.

Index

Constructors

Methods

EmitConfigFile MergeSchemaConfig MergeSoftPKs ParseExistingConfig

Constructors

constructor

new SoftFKConfigEmitter(): SoftFKConfigEmitter
Returns SoftFKConfigEmitter

Methods

EmitConfigFile

EmitConfigFile(
configPath: string,
mergedConfig: AdditionalSchemaInfo,
): EmittedFile
Produce an EmittedFile with the updated additionalSchemaInfo JSON.
Parameters
- configPath: string
- mergedConfig: AdditionalSchemaInfo
Returns EmittedFile
- Defined in packages/SchemaEngine/src/SoftFKConfigEmitter.ts:128

MergeSchemaConfig

MergeSchemaConfig(
existing: AdditionalSchemaInfo,
newEntries: SoftFKEntry[],
): AdditionalSchemaInfo
Merge new soft FK entries into an existing config. Deduplicates — won't add the same FK twice.
Parameters
- existing: AdditionalSchemaInfo
- newEntries: SoftFKEntry[]
Returns AdditionalSchemaInfo
- Defined in packages/SchemaEngine/src/SoftFKConfigEmitter.ts:54

MergeSoftPKs

MergeSoftPKs(
existing: AdditionalSchemaInfo,
tableDefs: TableDefinition[],
): AdditionalSchemaInfo
Add soft PK entries for tables. Uses SoftPrimaryKeys from TableDefinition.
Parameters
- existing: AdditionalSchemaInfo
- tableDefs: TableDefinition[]
Returns AdditionalSchemaInfo
- Defined in packages/SchemaEngine/src/SoftFKConfigEmitter.ts:98

ParseExistingConfig

ParseExistingConfig(jsonContent: string): AdditionalSchemaInfo
Parse existing additionalSchemaInfo JSON content. Returns empty object if content is empty/null.
Parameters
- jsonContent: string
Returns AdditionalSchemaInfo
- Defined in packages/SchemaEngine/src/SoftFKConfigEmitter.ts:43