API implements the API required for the model migration master worker.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "MigrationMaster"
VERSION: number = 2
_transport: Transport
NAME: string = "MigrationMaster"
VERSION: number = 2

Methods

  • Export serializes the model associated with the API connection.

    Parameters

    • params: any

    Returns Promise<SerializedModel>

  • MigrationStatus returns the details and progress of the latest model migration.

    Parameters

    • params: any

    Returns Promise<MasterMigrationStatus>

  • MinionReports returns details of the reports made by migration minions to the controller for the current migration phase.

    Parameters

    • params: any

    Returns Promise<MinionReports>

  • ModelInfo returns essential information about the model to be migrated.

    Parameters

    • params: any

    Returns Promise<MigrationModelInfo>

  • Prechecks performs pre-migration checks on the model and (source) controller.

    Parameters

    • params: any

    Returns Promise<any>

  • ProcessRelations processes any relations that need updating after an export. This should help fix any remoteApplications that have been migrated.

    Parameters

    Returns Promise<any>

  • Reap removes all documents for the model associated with the API connection.

    Parameters

    • params: any

    Returns Promise<any>

  • SetPhase sets the phase of the active model migration. The provided phase must be a valid phase value, for example QUIESCE" or "ABORT". See the core/migration package for the complete list.

    Parameters

    Returns Promise<any>

  • SetStatusMessage sets a human readable status message containing information about the migration's progress. This will be shown in status output shown to the end user.

    Parameters

    Returns Promise<any>

  • Watch starts watching for an active migration for the model associated with the API connection. The returned id should be used with the NotifyWatcher facade to receive events.

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

  • WatchMinionReports sets up a watcher which reports when a report for a migration minion has arrived.

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

Generated using TypeDoc