PostgreSQLConnector

概要

PostgreSQL向けに実装された DBConnector の派生クラスです。 このクラスはNode.js版でのみ利用できます。

このクラスは node-postgres に依存します。

コンストラクタ

構文

new PostgreSQLConnector({ database, usePool, onError, onConnect, onDisconnect })

引数

単一のオブジェクトです。 以下のプロパティに加えて、node-postgres の ClientConfig および PoolConfig で使用できるプロパティを指定できます：

• database: string

  データベース名です。

• usePool: boolean （省略可）

  コネクションプーリングを利用するかどうかを表す論理値です。

  true ならプーリングを利用し、false なら利用しません。

  usePool の値によってコンストラクタに渡すことのできる引数が異なります。 node-postgres の PoolConfig にのみ定義されている引数は usePool が false の場合は意味を持ちません。

  このプロパティの指定は任意です。指定がない場合、コネクションプーリングは利用しません（false）。

• onError: function （省略可）

  エラーを捕捉した際に呼び出されるコールバック関数です。

  この関数は第1引数としてエラーオブジェクト、第2引数としてエラーが発生した pg.Client を受け取ります。

  このプロパティの指定は任意です。指定しなかった場合、エラー捕捉時に何も行われません。

• onConnect: function （省略可）

  データベースへ接続した際に呼び出されるコールバック関数です。

  この関数は第1引数として新たに接続された pg.Client を受け取ります。

  このプロパティの指定は任意です。指定しなかった場合、接続時に何も行われません。

• onDisconnect: function （省略可）

  データベースからクライアントが切断された際に呼び出されるコールバック関数です。

  この関数は第1引数として接続が切れた pg.Client を受け取ります。

  このプロパティの指定は任意です。指定しなかった場合、切断時に何も行われません。

例外

• TypeError
  • 引数のプロパティ database に文字列が指定されていない場合
  • 引数のプロパティ onError に指定された値が関数でなかった場合
  • 引数のプロパティ onConnect に指定された値が関数でなかった場合
  • 引数のプロパティ onDisconnect に指定された値が関数でなかった場合

解説

PostgreSQLConnector のインスタンスを生成します。

コネクションプールを使用しない場合、データベースクライアントの初期化は connect() の呼び出しまで遅延します。

メソッド

end()

• 使用しているすべてのクライアントとコネクションプールを解放します。

execute()

• SQL文を実行します。

connect()

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

disconnect()

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

fixPreparedStatementQuery()

• 与えられた SQL 文のプレースホルダーを PostgreSQL で使用可能な文字列に置換します。

asIdentifier()

• 文字列をデータベースで使用する識別子として変換します。

asString()

• 文字列をデータベースで使用する文字列リテラルに変換します。

asValue()

• データをデータベースで使用する値リテラルに変換します。