DBConnector: connect()

データベースへ接続します。

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

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

構文

dbConnector.connect() => Promise<boolean>

返値: Promise<boolean>

データベース接続の結果を表す Promise です。

履行時に boolean を与えます。 true ならデータベース接続に成功したことを、false なら失敗したことを示します。

既に接続済みだった場合、接続成功として true を与えます。

例外

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

  • DBInternalError
    • この関数が未実装だった場合
warning

  • DBInternalError を try-catch 文の中で catch した場合、何もせず再び throw してください。この例外はアプリケーション実行時に発生するべきではありません。

    その他のアプリケーションエラーと区別するため、この関数で発生した例外は必ず instanceof で型を検査してください。

解説

データベースへ接続します。

既に接続済みだった場合、データベースへの接続は成功とみなされます。

データベースへの接続やコネクションプールの初期化が非同期で行われる場合、この関数の呼び出し時点でそれらが待ち合わせられ（初期化が遅延実行され）、接続可能な状態になってから接続処理を試みます。