5.5.2. mroonga_escape() — Mroonga vmrn_version documentation

本文へスキップ
`Ctrl`+`K`

# 5.5.2. `mroonga_escape()`

Added in version 3.08.

## 5.5.2.1. 概要

`mroonga_escape` UDF は与えられた文字列をエスケープする機能を提供します。そしてまたエスケープすべき文字を引数として受け取ります。

## 5.5.2.2. 構文

`mroonga_escape()` には必須引数と省略可能引数とがあります。:

    mroonga_escape(string)
    mroonga_escape(string, special_characters)

## 5.5.2.3. 使いかた

エスケープされた特殊文字を使うクエリーの例です。:

    SELECT * FROM `symbols` WHERE MATCH(`content`) AGAINST(mroonga_escape("+hello_world()", "()") IN BOOLEAN MODE);

特殊文字のエスケープ例です。:

    SELECT mroonga_escape("+-<>~*()\"\\\:");
    -- \+\-\<\>\~\*\(\)\"\\\:

## 5.5.2.4. 引数

### 5.5.2.4.1. 必須引数

必須引数は `string` です。

#### 5.5.2.4.1.1. `string`

エスケープしたいテキストを指定します。

### 5.5.2.4.2. 省略可能引数

`special_characters` は省略可能な引数です。

#### 5.5.2.4.2.1. `special_characters`

エスケープする文字を指定します。

デフォルト値は `+-<>~*()"\\:` です。

## 5.5.2.5. 返り値

エスケープされた文字列を返します。