PostgreSQLConnector: disconnect()

データベースの接続を切断します。

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

構文

postgresqlConnector.disconnect() => Promise<void>

返値: Promise<void>

データベースへの接続が切断された際に履行される Promise を返します。

例外

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

• DBError
  • データベース接続の切断に失敗した場合
  • 使用中のプールされたクライアントの解放に失敗した場合

解説

データベースの接続を切断します。

コネクションプール使用している場合（PosgreSQLConnector # コンストラクタ を参照）、プールから取得したクライアントを解放し、プールへ返却します。 コネクションプールを使用しない場合、使用中のクライアントを破棄します。

接続済みのクライアントが存在しない場合、この関数は何も行いません。

onDisconnect コールバック関数をコンストラクタ呼び出し時に指定している場合、この関数によってクライアントがデータベースから切断されるたび、onDisconnect 関数が呼び出されます。