no versions found for ApplicationFrameworkReferences / Utility/Database/DBConnector/dbconnector_compile / en

DBConnector: compile

SQL文をコンパイルし、コンパイルされたSQL文の識別子を取得します。

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

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

構文

dbConnector.compile(statement) => Promise<number>

引数

  • statement: string

    コンパイルの対象となる、単一のSQL文です。

返値: Promise<number>

履行時にコンパイルされたSQL文の識別子を与える Promise です。 識別子は正の整数を表す number 型の値です。

ここで得られた識別子はそれぞれ releasePreparedStatement() および executePreparedStatement() の呼び出しに使用します。

例外

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

  • DBInternalError
    • この関数が未実装だった場合
  • DBError
    • 与えられた文字列が SQL 文として正しくない場合
    • 与えられた文字列が SELECT, INSERT, UPDATE, DELETE の いずれのコマンドを実行する SQL 文でもなかった場合
warning
  • DBInternalError を try-catch 文の中で catch した場合、何もせず再び throw してください。この例外はアプリケーション実行時に発生するべきではありません。 その他のアプリケーションエラーと区別するため、この関数で発生した例外は必ず instanceof で型を検査してください。

解説

SQL文をコンパイルし、コンパイルされたSQL文の識別子を取得します。