Member Junction
    Preparing search index...

    Interface SchemaBuilderInput

    Complete input to the SchemaBuilder orchestrator.

    interface SchemaBuilderInput {
        AdditionalSchemaInfoPath: string;
        EntitySettingsForTargets: Record<string, { Name: string; Value: string }[]>;
        ExistingTables: ExistingTableInfo[];
        MetadataDir: string;
        MigrationsDir: string;
        MJVersion: string;
        Platform: DatabasePlatform;
        SourceSchema: SourceSchemaInfo;
        SourceType: string;
        TargetConfigs: TargetTableConfig[];
    }
    Index

    Properties

    AdditionalSchemaInfoPath EntitySettingsForTargets ExistingTables MetadataDir MigrationsDir MJVersion Platform SourceSchema SourceType TargetConfigs

    Properties

    AdditionalSchemaInfoPath: string

    Absolute path to the additionalSchemaInfo JSON file — pass RuntimeSchemaManager.AdditionalSchemaInfoPath so the builder merges into the same file RSU writes and CodeGen reads. A relative path resolves against process.cwd(), which need not be the directory CodeGen resolves against (#5858).

    EntitySettingsForTargets: Record<string, { Name: string; Value: string }[]>

    EntitySettings for any __mj target entities (keyed by entity name).

    ExistingTables: ExistingTableInfo[]

    Current state of target tables (for evolution scenarios). Empty array for new tables.

    MetadataDir: string

    Path to metadata directory (e.g., "metadata").

    MigrationsDir: string

    Path to migrations directory (e.g., "migrations/v2").

    MJVersion: string

    Current MJ version for migration naming.

    Platform: DatabasePlatform

    Target database platform.

    SourceSchema: SourceSchemaInfo

    Introspected source schema from connector.

    SourceType: string

    Source system name (e.g., "HubSpot").

    TargetConfigs: TargetTableConfig[]

    User's customizations for target tables.

    Settings

    Member Visibility

    On This Page

    Properties