MySQLConnector

概要

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

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

コンストラクタ

構文

new MySQLConnector({ database, useAnsiQuotes, usePool, onError, onConnect, onDisconnect })

引数

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

• database: string

  データベース名です。

• useAnsiQuotes: boolean | undefined （省略可）

  対向のMySQLサーバで ANSI_QUOTES が有効と見なすかどうかです。

  true なら ANSI_QUOTES が有効と見なし、false なら無効と見なします。

  useAnsiQuotes の値は以下の関数の呼び出し結果に影響します：

  • asIdentifier()
  • asString()
  • asValue()

  ANSI_QUOTES が有効と見なす場合、上記の関数呼び出しにおいて、識別子のエスケープには二重引用符（"）を使い、文字列リテラルには単引用符（'）を使います。 ANSI_QUOTES が無効と見なす場合、上記の関数呼び出しにおいて、識別子には逆引用符（`）を使い、文字列リテラルには二重引用符（"）を使います。

  このプロパティの指定は任意です。指定がない場合、ANSI_QUOTES が無効であると見なします（false）。

• usePool: boolean | undefined （省略可）

  コネクションプーリングを利用するかどうかを表します。

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

  usePool の値によってコンストラクタに渡すことのできるオプションが異なります。 usePool が false の場合、node-mysql2 の PoolOptions にのみ定義されているオプションは指定できません。

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

• onError: function | undefined （省略可）

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

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

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

• onConnect: function | undefined （省略可）

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

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

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

• onDisconnect: function | undefined （省略可）

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

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

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

例外

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

詳細

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

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

メソッド

end()

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

execute()

• SQL文を実行します。

connect()

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

disconnect()

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

fixPreparedStatementQuery()

• この関数は何も行いません。

asIdentifier()

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

asString()

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

asValue()

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