# mroonga\_escape

## Syntax

```
mroonga_escape (string [,special_characters])
```

* `string` - required parameter specifying the text you want to escape
* `special_characters` - optional parameter specifying the characters to escape

## Description

`mroonga_escape` is a [user-defined function](https://mariadb.com/docs/server/server-usage/user-defined-functions) (UDF) included with the [Mroonga storage engine](https://mariadb.com/docs/server/server-usage/storage-engines/mroonga), used for escaping a string. See [Creating Mroonga User-Defined Functions](https://mariadb.com/docs/server/server-usage/storage-engines/mroonga/mroonga-user-defined-functions/creating-mroonga-user-defined-functions) for details on creating this UDF if required.

If no `special_characters` parameter is provided, by default `+-<>*()":` are escaped.

Returns the escaped string.

## Example

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

## See Also

* [Creating Mroonga User-Defined Functions](https://mariadb.com/docs/server/server-usage/storage-engines/mroonga/mroonga-user-defined-functions/creating-mroonga-user-defined-functions)

<sub>*This page is licensed: CC BY-SA / Gnu FDL*</sub>

{% @marketo/form formId="4316" %}