Member Junction
    Preparing search index...

    Class SchemaBuilder

    Main entry point for the Integration Schema Builder. Delegates DDL generation to @memberjunction/schema-engine and adds integration-specific artifacts (sync columns, soft FKs, metadata files).

    Index

    Constructors

    constructor

    Methods

    BuildRSUInput BuildSchema RunSchemaPipeline

    Constructors

    Methods

    • Convert SchemaBuilderOutput into an RSUPipelineInput suitable for RuntimeSchemaManager.RunPipeline().

      Parameters

      • schemaOutput: SchemaBuilderOutput
      • input: SchemaBuilderInput
      • OptionalrsuOptions: {
            AdditionalSchemaInfoAuthoritative?: boolean;
            SkipGitCommit?: boolean;
            SkipRestart?: boolean;
        }

      Returns RSUPipelineInput

    • Build schema artifacts AND execute the full Runtime Schema Update pipeline.

      This is the end-to-end integration flow:

      1. Call BuildSchema() to generate migration SQL, soft FK config, and metadata
      2. Feed the output into RuntimeSchemaManager.RunPipeline()
      3. Pipeline executes: migration → CodeGen → compile → restart MJAPI → git commit/PR

      Returns both the SchemaBuilderOutput and the RSU pipeline result.

      Parameters

      • input: SchemaBuilderInput

        — Standard SchemaBuilderInput

      • OptionalrsuOptions: { SkipGitCommit?: boolean; SkipRestart?: boolean }

        — Optional overrides for the RSU pipeline (e.g., SkipGitCommit, SkipRestart)

      Returns Promise<
          { PipelineResult: RSUPipelineResult; SchemaOutput: SchemaBuilderOutput },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods