copier

type Config ¶

type Config = state.OperationConfig

Config is a type alias for state.OperationConfig for backward compatibility

type Copier ¶

type Copier struct {
	// contains filtered or unexported fields
}

Copier handles the data copying operation using centralized state management.

Copier orchestrates the entire data migration process:

• Discovering tables and their metadata from the source database
• Managing foreign key constraints (drop/restore or replica mode)
• Coordinating parallel worker goroutines for data copying
• Tracking progress and emitting updates to display components

Lifecycle ¶

Create a Copier with New() or NewWithState(), then call Copy() to execute. Always call Close() when finished to release database connections and files.

Configuration ¶

The Copier behavior is controlled by state.OperationConfig:

• Parallel: Number of concurrent worker goroutines (default: CPU cores)
• BatchSize: Rows per INSERT batch (affects memory and performance)
• IncludeTables/ExcludeTables: Table filtering (supports wildcards)
• DryRun: Validate without modifying destination

Error Recovery ¶

Individual table failures don't stop the entire operation. Failed tables are tracked in state and reported at completion. Foreign keys are restored even on partial failure.

Thread Safety: The Copier itself is not safe for concurrent Copy() calls. Use separate Copier instances for concurrent operations.

func New(config *Config) (*Copier, error)

func NewWithState(config *Config, copyState *state.CopyState) (*Copier, error)

func NewWithWebPort(config *Config, webPort ...int) (*Copier, error)

func (c *Copier) Close()

func (c *Copier) Copy(ctx context.Context) error

func (c *Copier) HasVitalOperations() bool

func (c *Copier) OnStateChange(_ *state.CopyState, event state.Event)

func (c *Copier) State() *state.CopyState

type CopyStats ¶

type CopyStats = state.Summary

CopyStats is deprecated - use state.Summary instead

type Discovery ¶ added in v0.4.0

type Discovery interface {
	DiscoverTables() ([]*TableInfo, error)
	DetectForeignKeys(tables []*TableInfo) error
}

Discovery is responsible for table / FK discovery and basic stats.

type DisplayMode ¶ added in v0.2.0

type DisplayMode string

DisplayMode represents different output modes for progress tracking

const (
	// DisplayModeRaw shows minimal output, suitable for headless/CI environments (default)
	// Note: Internal name remains "raw" for backwards compatibility in code
	DisplayModeRaw DisplayMode = "raw"
	// DisplayModeProgress shows a progress bar
	DisplayModeProgress DisplayMode = "progress"
	// DisplayModeInteractive shows an interactive live display with table details
	DisplayModeInteractive DisplayMode = "interactive"
	// DisplayModeWeb launches a web interface for monitoring the copy process
	DisplayModeWeb DisplayMode = "web"
)

type Executor ¶ added in v0.4.0

type Executor interface {
	Execute(ctx context.Context, tables []*TableInfo) error
}

Executor runs the data movement for a planned set.

type ForeignKey ¶

type ForeignKey struct {
	ConstraintName    string
	Schema            string
	Table             string
	Columns           []string
	ReferencedSchema  string
	ReferencedTable   string
	ReferencedColumns []string
	OnDelete          string
	OnUpdate          string
	Definition        string // Full CREATE CONSTRAINT statement
}

ForeignKey represents a foreign key constraint

type ForeignKeyManager ¶

type ForeignKeyManager struct {
	// contains filtered or unexported fields
}

ForeignKeyManager handles foreign key operations

func NewForeignKeyManager(db *sql.DB, logger *utils.SimpleLogger, noTimeouts bool) *ForeignKeyManager

func (fkm *ForeignKeyManager) Cleanup() error

func (fkm *ForeignKeyManager) CleanupBackupFile() error

func (fkm *ForeignKeyManager) Detect(tables []*TableInfo) error

func (fkm *ForeignKeyManager) DetectForeignKeys(tables []*TableInfo) error

func (fkm *ForeignKeyManager) DisableReplicaMode() error

func (fkm *ForeignKeyManager) DropAllForeignKeys(tables []*TableInfo) error

func (fkm *ForeignKeyManager) DropForeignKeysForTable(table *TableInfo) error

func (fkm *ForeignKeyManager) GetForeignKeyStats() (total, dropped int)

func (fkm *ForeignKeyManager) IsUsingReplicaMode() bool

func (fkm *ForeignKeyManager) RecoverFromBackupFile() error

func (fkm *ForeignKeyManager) RestoreAllForeignKeys() error

func (fkm *ForeignKeyManager) SetLogger(logger *utils.SimpleLogger)

func (fkm *ForeignKeyManager) TryUseReplicaMode() error

func (fkm *ForeignKeyManager) ValidateRestoredForeignKeys() error

type ForeignKeyStrategy ¶ added in v0.4.0

type ForeignKeyStrategy interface {
	Detect(tables []*TableInfo) error
	Cleanup() error // after all tables
}

ForeignKeyStrategy abstracts FK handling modes.

type InteractiveDisplay ¶ added in v0.2.0

type InteractiveDisplay struct {
	// contains filtered or unexported fields
}

InteractiveDisplay manages the interactive CLI display

func NewInteractiveDisplay(state *state.CopyState) *InteractiveDisplay

func (d *InteractiveDisplay) Start()

func (d *InteractiveDisplay) Stop()

type Persistence ¶ added in v0.4.0

type Persistence interface {
}

Persistence handles durable logging / summaries.

type Planner ¶ added in v0.4.0

type Planner interface {
	PlanTables(tables []*TableInfo) ([]*TableInfo, error)
	PlanLayers(tables []*TableInfo) ([][]*TableInfo, error)
}

Planner orders tables & resolves dependencies (currently passthrough).

type ProgressSink ¶ added in v0.4.0

type ProgressSink interface {
	UpdateTable(schema, table string, rowsCopied int64)
	Log(level, msg, scope, table string)
	Done()
}

ProgressSink receives progress events decoupled from execution.

type Reporter ¶ added in v0.4.0

type Reporter interface {
}

Reporter handles state broadcasting / console rendering (future use).

type TableInfo ¶

type TableInfo = state.TableState

TableInfo is a type alias for state.TableState for backward compatibility