asSqlString

与えられた文字列をSQLの文字列リテラルを表す文字列に変換します。

構文

asSqlString(rawString) => string
asSqlString(rawString, useSingleQuote) => string

引数

• rawString: string

  SQLの文字列リテラルへ変換する文字列です。

• useSingleQuote: boolean | undefined （省略可）

  引用符が必要な識別子に単引用符（"）を使うかどうかです。

  true なら単引用符を使い、false なら二重引用符（"）を使います。

  この引数の指定は任意です。指定がない場合、単引用符を使います（true）。

返値: string

変換結果の文字列です。

引数 rawString を引用符で囲んだ値が返ります。

使用する引用符は引数 useSingleQuote の値によって異なり、true なら単引用符（'）を、false なら二重引用符（"）を使います。

引数 rawString に引用符が含まれる場合、useSingleQuote が true なら単引用符を '' に、useSingleQuote が false なら二重引用符を "" にそれぞれ置換します。

解説

与えられた文字列をSQLの文字列リテラルを表す文字列に変換します。

SQL文の中で文字列リテラルを要求する箇所に値を挿入する際に利用できます。