hubio-sync migrations

Manage migration jobs.

Synopsis

hubio-sync migrations <subcommand> [flags]

Description

View and control migration jobs that are running or have completed. This command allows you to list, pause, resume, and cancel migrations.

Subcommands

SubcommandDescription
listList migrations
resumeResume a paused migration
pausePause an in-progress migration
cancelCancel a migration

hubio-sync migrations list

List migration jobs.

Synopsis

hubio-sync migrations list [flags]

Flags

FlagShortDescription
--state-sFilter by state (pending, running, paused, completed, failed)
--jsonOutput in JSON format

Examples

# List all migrations
hubio-sync migrations list

Output:

Migrations
==========

  [1] mysql-prod-to-s3-archive
      ID: abc123-def456
      Source: src_mysql123 → Destination: dst_s3789
      Status: InProgress (67.3%)
      Started: 2025-12-03 14:30:00

  [2] postgres-backup
      ID: xyz789-abc123
      Source: src_pg456 → Destination: dst_s3backup
      Status: Completed (100.0%)
      Started: 2025-12-03 10:00:00
      Completed: 2025-12-03 10:15:23
# List only running migrations
hubio-sync migrations list -s running
# List failed migrations
hubio-sync migrations list -s failed
# JSON output
hubio-sync migrations list --json

hubio-sync migrations resume

Resume a paused migration.

Synopsis

hubio-sync migrations resume <id-or-name>

Description

Resumes a paused migration from where it left off. The migration state is checkpointed, so no data is re-processed.

Example

hubio-sync migrations resume mysql-backup

Output:

✓ Migration 'mysql-backup' resumed

Note: The daemon needs to be running to continue the migration.

Requirements

  • The migration must be in Paused state
  • The scheduler daemon should be running to execute the resumed migration

hubio-sync migrations pause

Pause an in-progress migration.

Synopsis

hubio-sync migrations pause <id-or-name>

Description

Gracefully pauses a running migration. The current batch will complete before pausing. State is checkpointed for later resumption.

Example

hubio-sync migrations pause mysql-backup

Output:

✓ Migration 'mysql-backup' paused
Run 'hubio-sync migrations resume' to continue.

Requirements

  • The migration must be in InProgress state

hubio-sync migrations cancel

Cancel a migration.

Synopsis

hubio-sync migrations cancel <id-or-name>

Description

Cancels a running or paused migration. Unlike pause, cancelled migrations cannot be resumed. The migration is marked as failed with a cancellation message and kept in history.

Example

hubio-sync migrations cancel mysql-backup

Output:

Cancelling migration: mysql-backup [abc123-def456]
✓ Migration cancelled

Restrictions

  • Cannot cancel a completed migration
  • Cancelled migrations remain in history as failed

Migration States

StateDescriptionCan PauseCan ResumeCan Cancel
PendingJob created but not yet startedNoNoYes
InProgressCurrently runningYesNoYes
PausedTemporarily pausedNoYesYes
CompletedSuccessfully finishedNoNoNo
FailedEncountered an errorNoNoNo

Data Storage

Migration job state is stored locally:

PlatformPath
macOS~/.local/share/hubio-sync/jobs.json
Linux~/.local/share/hubio-sync/jobs.json
Windows%LOCALAPPDATA%\hubio-sync\data\jobs.json

See Also