PreparedStatement: execute()

プリペアードステートメントを実行します。

構文

preparedStatement.execute(...params) => Promise<object>

引数

• params: Array<any>

  プリペアードステートメントのプレースホルダを置換する値の配列です。

  この引数は残余引数です。

返値: Promise<object>

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

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

• status: true

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

• records: Array<object> | undefined

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

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

• status: false

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

• message: string | undefined

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

解説

プリペアードステートメントを実行します。

このメソッドは以下の場合に失敗を通知するオブジェクトを返します：

• 引数 params の要素数が対象の PreparedStatement が持つプレースホルダの個数より多かった場合