AlierDB: delete()

対象のデータベースから、指定したテーブルを削除します。

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

構文

alierDb.delete({ table }) => Promise<object>

引数

単一の、以下のプロパティを持つオブジェクトを引数に取ります。

• table: string

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

返値: Promise<object>

テーブルの削除に成功したかどうかを表すオブジェクトを与える Promise です。

成功時には、結果のオブジェクトは以下のプロパティを持ちます：

• status: true

  成功したかどうかを表す boolean です。常に true を取ります。

失敗時には、結果のオブジェクトは以下のプロパティを持ちます：

• status: false

  成功したかどうかを表す boolean です。常に false を取ります。

• message: string | undefined

  エラーメッセージです。エラーの詳細が分かっている場合にのみ定義されます。

例外

• TypeError
  • 引数オブジェクトのプロパティ table が指定されていない場合

解説

対象のデータベースから、指定したテーブルを削除します。

この関数はテーブル削除後、対象の AlierDB のプロパティ schema を更新します。

この関数の実装は DBConnector.dropTable() に依存します。