DBConnector: execute()

SQL文を実行します。

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

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

構文

dbConnector.execute(statement, ...params) => Promise<object>

引数

  • statement: string

    単一のSQL文です。

  • params: Array<any> （省略可）

    SQL文のプレースホルダーを置換する値の配列です。

返値: Promise<object>

履行時に SQL文の実行結果を与える Promise です。

SQL文の実行に成功した場合は以下のプロパティを持つオブジェクトが返ります：

  • status: true

    SQL文の実行に成功したかどうかを表します。この値は必ず true です。

  • records: Array<any> | undefined

    SELECT 文を実行した場合、その結果を表すレコード（行）の配列です。

    レコードが返らないSQL文を実行した場合、このプロパティは定義されません。

SQL文の実行に失敗した場合は以下のプロパティを持つオブジェクトが返ります：

  • status: false

    SQL文の実行に成功したかどうかを表します。この値は必ず false です。

  • message: string | undefined

    エラー情報を示した文字列です。

    エラー情報がない場合、このプロパティは定義されません。

例外

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

warning
  • DBInternalError を try-catch 文の中で catch した場合、何もせず再び throw してください。この例外はアプリケーション実行時に発生するべきではありません。 その他のアプリケーションエラーと区別するため、このメソッドで発生した例外は必ず instanceof で型を検査してください。

解説

SQL文を実行します。