no versions found for ApplicationFrameworkReferences / Utility/Database/DBConnector/dbconnector_droptable / en

DBConnector: deleteTable()

指定されたテーブルを削除します。

この関数は非同期関数です。

note
  • この関数は基底クラスでは実装されていません。派生クラスでは以下に示す仕様を満たすようにこの関数を実装する必要があります。

構文

dbConnector.dropTable(tableName) => Promise<void>

引数

  • tableName: string

    削除するテーブルの名前です。

返値: Promise<void>

テーブル作成が完了した際に履行される Promise です。 履行した際、この Promise は追加の情報を与えません。

例外

以下の例外は返値の Promise が棄却された際に発生します。

  • DBInternalError
    • この関数が未実装だった場合
  • DBError
    • テーブルの削除に失敗した場合
warning

  • DBInternalError を try-catch 文の中で catch した場合、何もせず再び throw してください。この例外はアプリケーション実行時に発生するべきではありません。

    その他のアプリケーションエラーと区別するため、この関数で発生した例外は必ず instanceof で型を検査してください。

解説

指定されたテーブルを削除します。