Skip to main content

MigrationClient

@appfire/ace-migration-helperDocs


@appfire/ace-migration-helper / MigrationClient

Class: MigrationClient

A class responsible for handling the migration of addon settings to Fuse DynamoDB table.

Constructors

new MigrationClient()

new MigrationClient(awsConfig): MigrationClient

Parameters

awsConfig: AWSConfig

AWS configuration object containing region and profile or endpoint. If migration is performed into AWS hosted DynamoDB profile from your ~/.aws/credentials file should be specified (e.g. 'sandbox', 'dts', 'production') If migration is performed into emulated database, endpoint should be specified (e.g. http://localhost:8000)

Returns

MigrationClient

Throws

If neither an endpoint nor a profile is specified, or both are provided.

Defined in

migration-client/index.ts:20

Properties

TABLE_NAME

readonly static TABLE_NAME: "appfire-atlassian-persist-prod-AppSettings" = 'appfire-atlassian-persist-prod-AppSettings'

Defined in

migration-client/index.ts:11

Methods

migrateToFuse()

migrateToFuse(getAddonSettings): Promise\<void>

Migrates addon settings to the Fuse DynamoDB table.

This asynchronous method retrieves addon settings via the getAddonSettings callback.

Parameters

getAddonSettings

A function that returns a Promise resolving to an array of AddonSettings.

Returns

Promise\<void>

Defined in

migration-client/index.ts:47