AlierTable: delete()

対象のテーブルから、条件に合致するレコードを削除します。

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

構文

alierTable.delete() => Promise<object>
alierTable.delete({ filter }) => Promise<object>

引数

単一の、以下のプロパティを持つオブジェクトです。 このオブジェクトの指定は任意です。指定がない場合、以下のすべてのプロパティについて既定の値が使われます。

• filter: string | undefined （省略可）

  削除するレコードの条件です（WHERE）。

  条件式の記法についてはSQL 式のスクリプト上での表現を参照してください。

  このプロパティの指定は任意です。指定がない場合、すべてのレコードが削除されます。

返値: Promise<object>

実行結果 のオブジェクトです。

解説

対象のテーブルから、条件に合致するレコードを削除します。

使用例は実行例を参照してください。