SchemaMigrationRegistry

Registry and planner for sequential schema migrations.

Constructor

new SchemaMigrationRegistry()

Classes

SchemaMigrationRegistry

Members

_migrations :Map.<number, Object>

Type:
  • Map.<number, Object>

Methods

clear()

Clear all registered migrations.

get(fromVersion) → {Object|null}

Get migration step starting from fromVersion.

Parameters:
NameTypeDescription
fromVersionnumber
Returns:
Type: 
Object | null

getPlan(fromVersion, targetVersion) → {Array.<Object>}

Plan sequential migration steps from sourceVersion to targetVersion.

Parameters:
NameTypeDescription
fromVersionnumber
targetVersionnumber
Returns:
Type: 
Array.<Object>

has(fromVersion) → {boolean}

Check if a migration is registered from fromVersion.

Parameters:
NameTypeDescription
fromVersionnumber
Returns:
Type: 
boolean

register(fromVersion, toVersionOrFn, maybeFnopt, optionsopt) → {SchemaMigrationRegistry}

Register a migration step. Can be called as register(fromVersion, toVersion, migrateFn, options) or register(fromVersion, migrateFn, options) where toVersion = fromVersion + 1.

Parameters:
NameTypeAttributesDescription
fromVersionnumber
toVersionOrFnnumber | function
maybeFnfunction<optional>
optionsObject<optional>