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β
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| deleteOld | boolean | β | false | Delete old data after migration |
Returnsβ
Promise<boolean>- Resolves totrueon success, orfalsewhen the migration logs a recoverable failure.
Throwsβ
- Does not throw for migration failures; failed runs log through
XpLog.err()and resolvefalse.
Migrate.fromDB()β
Migrates from MongoDB to SQLite, or vice versa.
Parametersβ
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| dbType | "mongodb" or "sqlite" | β | The source database type to migrate from. | |
| connection | better-sqlite3 Database or MongoClient | β | The source database connection. |
Returnsβ
Promise<boolean>- Resolves totrueon success, orfalsewhen 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β
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| keepOld | boolean | β | false | Keep old legacy records after migration (instead of deleting legacy rows). |
Returnsβ
Promise<boolean>- Resolves totrueon success, orfalsewhen the migration logs a recoverable failure.
Throwsβ
- Does not throw for migration failures; failed runs log through
XpLog.err()and resolvefalse.