Skip to main content
Version: v2.0

Migrate

This class provides one-off helpers for migrating from legacy packages, schemas, and database backends.

Methods​

Migrate.discord_xp()​

Migrates from discord-xp to simply-xp.

Parameters​

ParameterTypeRequiredDefaultDescription
deleteOldboolean❌falseDelete old data after migration

Returns​

  • Promise<boolean> - Resolves to true on success, or false when the migration logs a recoverable failure.

Throws​

  • Does not throw for migration failures; failed runs log through XpLog.err() and resolve false.

Migrate.fromDB()​

Migrates from MongoDB to SQLite, or vice versa.

Parameters​

ParameterTypeRequiredDefaultDescription
dbType"mongodb" or "sqlite"βœ…The source database type to migrate from.
connectionbetter-sqlite3 Database or MongoClientβœ…The source database connection.

Returns​

  • Promise<boolean> - Resolves to true on success, or false when reading the source database fails.

Throws​

  • XpFatal - If invalid parameters or an unsupported database package/version are provided.

Migrate.roleSetup()​

Migrates legacy roleSetup records to the V2 LevelRoles schema.

Parameters​

ParameterTypeRequiredDefaultDescription
keepOldboolean❌falseKeep old legacy records after migration (instead of deleting legacy rows).

Returns​

  • Promise<boolean> - Resolves to true on success, or false when the migration logs a recoverable failure.

Throws​

  • Does not throw for migration failures; failed runs log through XpLog.err() and resolve false.