modelmigration

Documentation

Index

• func RegisterExport(coordinator Coordinator)
• func RegisterImport(coordinator Coordinator, defaultsProvider service.ModelDefaultsProvider, ...)
• type Coordinator
• type ExportService
• type ImportService

Functions

func RegisterExport

func RegisterExport(coordinator Coordinator)

RegisterExport registers the export operations with the given coordinator.

func RegisterImport

func RegisterImport(
	coordinator Coordinator, defaultsProvider service.ModelDefaultsProvider, logger logger.Logger,
)

RegisterImport registers the import operations with the given coordinator.

Types

type Coordinator

type Coordinator interface {
	// Add adds the given operation to the migration.
	Add(modelmigration.Operation)
}

Coordinator is the interface that is used to add operations to a migration.

type ExportService

type ExportService interface {
	// ModelConfig returns the current config for the model.
	ModelConfig(ctx context.Context) (*config.Config, error)
}

ExportService provides a subset of the external controller domain service methods needed for external controller export.

type ImportService

type ImportService interface {
	// SetModelConfig will remove any existing model config for the model and
	// replace with the new config provided. The new config will also be hydrated
	// with any model default attributes that have not been set on the config.
	SetModelConfig(
		ctx context.Context,
		cfg map[string]any,
	) error
}

ImportService represents the service methods needed for model config.