core

Documentation

Overview

Package core provides the high-level collection pipeline that turns a Config into a fully-resolved IR Catalog, Query list, and Migration list.

Index

• func Collect(cfg *config.Config) (*irv1.Catalog, error)
• func Generate(cfg *config.Config) error
• type Result
  • func Gather(cfg *config.Config) (*Result, error)

Functions

func Collect

func Collect(cfg *config.Config) (*irv1.Catalog, error)

Collect parses the configured SQL + migrations into the IR Catalog.

func Generate

func Generate(cfg *config.Config) error

Generate runs each configured plugin against the collected IR and writes the generated files to disk. Disabled plugins (IsEnabled() == false) are skipped.

Types

type Result

type Result struct {
	Catalog     *irv1.Catalog
	Queries     []*pluginv1.Query
	Migrations  []*pluginv1.Migration
	Diagnostics *catalog.Diagnostics
	Units       []source.Unit
}

Result is the full output of a collection pass.

func Gather

func Gather(cfg *config.Config) (*Result, error)

Gather runs the full pipeline and returns the catalog, queries, migrations, source units, and accumulated diagnostics.