メインコンテンツまでスキップ
バージョン: v2.0

Migrate

このクラスは、レガシーパッケージ、古いスキーマ、データベースバックエンドから移行するための一度きりのヘルパーを提供します。

Methods

Migrate.discord_xp()

discord-xp から simply-xp へ移行します。

パラメーター

ParameterTypeRequiredDefaultDescription
deleteOldbooleanfalse移行後に古いデータを削除するか。

戻り値

  • Promise<boolean> - 成功時は true、回復可能な失敗をログ出力した場合は false に解決されます。

例外

  • 移行失敗時には例外を送出しません。失敗した実行は XpLog.err() でログ出力され、false に解決されます。

Migrate.fromDB()

MongoDB から SQLite へ、またはその逆へ移行します。

パラメーター

ParameterTypeRequiredDefaultDescription
dbType"mongodb" or "sqlite"移行元データベースの種類。
connectionbetter-sqlite3 Database or MongoClient移行元データベース接続。

戻り値

  • Promise<boolean> - 成功時は true、移行元データベースの読み取りに失敗した場合は false に解決されます。

例外

  • XpFatal - 無効なパラメーター、または未対応のデータベースパッケージ/バージョンが指定された場合。

Migrate.roleSetup()

レガシーな roleSetup レコードを V2 の LevelRoles スキーマへ移行します。

パラメーター

ParameterTypeRequiredDefaultDescription
keepOldbooleanfalse移行後も古いレガシーレコードを保持するか。

戻り値

  • Promise<boolean> - 成功時は true、回復可能な失敗をログ出力した場合は false に解決されます。

例外

  • 移行失敗時には例外を送出しません。失敗した実行は XpLog.err() でログ出力され、false に解決されます。