レコードの削除(Web API)

Forguncyではレコードの削除を行うための以下のメソッドを提供しています。

Forguncy.deleteTableData( tableName, primaryKey, successCallback, errorCallback)

指定したテーブルに対してレコードが一意になるフィールド名と値を指定し、1件のレコード内容を削除します。

パラメーター

tableName

Type: String

削除したいデータが格納されているテーブルの名前。

primaryKey

Type: PlainObject

削除対象のレコードにおいて一意となるフィールド名と値を指定。
※プロパティ名にフィールド名、値にそのフィールドの値を持つオブジェクトを指定します。
※指定するフィールドが必ずしもデータベース上で一意制約を持つフィールドである必要はありません。

successCallback

Type: Function

レコードの削除が成功したときに実行するコールバック関数を指定します。

errorCallback

Type: Function( String errorMessage )

レコードの削除が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。
なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

 

 サンプルコード

Forguncy.deleteTableData("テーブル1", { "ID": 2 },
    function () {             // レコードの削除に成功した場合
        alert("レコードが1件削除されました。");
    },
    function (errorMessage) {        // レコードの削除に失敗した場合
        alert(errorMessage);
    }
);

複数のフィールドを組み合わせて一意なレコードを特定する場合、以下のようなコードを使用します。

Forguncy.deleteTableData("テーブル1", { "ID1": 2, "ID2" : 33  }, 
    function () {             // レコードの削除に成功した場合
        alert("レコードが1件削除されました。");
    },
    function (errorMessage) {        // レコードの削除に失敗した場合
        alert(errorMessage);
    }
);