AlierDB: execSQL()

対象のデータベースに対して、指定されたSQL文を実行します。

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

構文

alierDb.execSQL(statement) => Promise<object>
alierDb.execSQL(statement, ...params) => Promise<object>

引数

  • statement: string

    SQL文を表す文字列です。

  • params: Array<any>

    プレースホルダーを置換するパラメタの配列です。

    この引数は残余引数です。 引数 statement で指定したSQL文にプレースホルダーの個数に等しい個数までのパラメタを指定できます（プレースホルダーが含まれない場合、この引数の個数は 0 でなければなりません）。

返値: Promise<object>

SQL 文の実行結果を表すオブジェクトを与える Promise です。

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

  • status: true

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

  • records: Array<object> | undefined

    取得したレコードを表す配列です。SELECT 文を実行した場合にのみ定義されます。

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

  • status: false

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

  • message: string | undefined

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

例外

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

  • TypeError
    • 引数 statement が文字列でなかった場合

解説

対象のデータベースに対して、指定されたSQL文を実行します。

実装は DBConnector.execute() に依存します。